Herd REST API

Application

- get /buildInfo
  - Gets the build information
  Implementation Notes
  
  Gets the build information.
  Response (Status 200)
  Model
  
  JSON Schema
  
  XML Example
  
  buildInformation {
  buildOs (string):
  The OS in which the current build was built
  ,
  buildUser (string):
  The user ID of the user that performed the build
  ,
  buildDate (string):
  The date/time when the build was performed
  ,
  buildNumber (string):
  The version number (from Maven POM) of the current build
  
  }
  
  { "buildOs": "string", "buildUser": "string", "buildDate": "string", "buildNumber": "string" }
  
  <?xml version="1.0" encoding="UTF-8"?> <buildInformation> <buildOs>string</buildOs> <buildUser>string</buildUser> <buildDate>string</buildDate> <buildNumber>string</buildNumber> </buildInformation>
  Response Content Type
  
  Hide Response
  Curl
  
  Request URL
  
  Response Body
  
  Response Code

Business Object Data

post /businessObjectData

createBusinessObjectData

Implementation Notes

Creates (i.e. registers) business object data. You may pre-register business object data by setting the status to one of the pre-registration statuses (UPLOADING, PENDING_VALID, and PROCESSING).

Requires WRITE permission on namespace

Parameter (body): the information needed to create the business object data
Parameter content type: Model JSON Schema XML Example businessObjectDataCreateRequest { namespace (string): The Namespace to which a Business Object Format is related , businessObjectDefinitionName (string): The name of the Business Object Definition to which a Business Object Format is related , businessObjectFormatUsage (string): The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions , businessObjectFormatFileType (string): A File Type known to the system that describes the file type of data stored under a Business Object Format , businessObjectFormatVersion (integer, optional): The Business Object Format Version for a previously registered Business Object Format , partitionKey (string): The Partition Key this Business Object Data is being registered with. This must be they Partition Key specified in the Business Object Format , partitionValue (string): The Partition Value that this Business Object Data is associated with , subPartitionValues (Array[string], optional): A list of Sub-Partition values associated with this Business Object Data , status (string, optional): The status of the Business Object Data. One of the following values: VALID, UPLOADING, PENDING_VALID, PROCESSING, INVALID, ARCHIVED, EXPIRED, or DELETED. Pre-registration status include UPLOADING, PENDING_VALID, and PROCESSING. Defaults to VALID if value is not provided , storageUnits (Array[storageUnitCreateRequest], optional): A container for Storage Units that contain data associated with the Business Object Data being registered , attributes (Array[attribute], optional): Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage. Attributes values are required for certain keys that are defined as Attribute Definitions in the Business Object Format , businessObjectDataParents (Array[businessObjectDataKey], optional): An optional list of Business Object Data parents (i.e. predecessors) that were used/needed in the creation of this data. This is used for data lineage. Each parent consists of the key data that uniquely defines a reference to a single Business Object Data. , createNewVersion (boolean, optional): If true, a new Business Object Data Version will be created and registered that supercedes a previous version. If false, then only an initial Business Object Data Version (version 0) is allowed to be registered } storageUnitCreateRequest { storageName (string): The name of the Storage that this Storage Unit is associated with. The Storage must be pre-existing in the system. Required when storageUnit is present , storageDirectory (storageDirectory, optional): A container for a Storage Directory that resides within a specific Storage Unit. Required when storageUnit is present and one of the following is true: storageFiles element is not present, discoverStorageFiles is enabled , storageFiles (Array[storageFile], optional): A container of various Storage Files that reside within a specific Storage Unit. Required when storageUnit is present and storageDirectory is not. Note: storageFiles cannot be specified when discoverStorageFiles is enabled. , discoverStorageFiles (boolean, optional): If true, enables the auto-discovery of all Storage Files in the specified Storage Directory. See notes on S3 consistency for important information } attribute { name (string): Attribute key , value (string, optional): Attribute value } businessObjectDataKey { namespace (string): The Namespace to which a Business Object Format is related , businessObjectDefinitionName (string): The name of the Business Object Definition to which a Business Object Format is related , businessObjectFormatUsage (string): The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions , businessObjectFormatFileType (string): A File Type known to the system that describes the file type of data stored under a Business Object Format , businessObjectFormatVersion (integer, optional): The Business Object Format Version for a previously registered Business Object Format , partitionValue (string): The Partition Value that this Business Object Data is associated with , subPartitionValues (Array[string], optional): A list of Sub-Partition values this Business Object Data is associated with , businessObjectDataVersion (integer, optional): The numeric version of a Business Object Data } storageDirectory { directoryPath (string): The fully qualified storage directory path } storageFile { filePath (string): The fully qualified file path to the data. When Storage Directory is specified, all Storage File paths should start with the Storage Directory path , fileSizeBytes (integer, optional): The file size in bytes , rowCount (integer, optional): The number of lines in the file } { "namespace": "string", "businessObjectDefinitionName": "string", "businessObjectFormatUsage": "string", "businessObjectFormatFileType": "string", "businessObjectFormatVersion": 0, "partitionKey": "string", "partitionValue": "string", "subPartitionValues": [ "string" ], "status": "string", "storageUnits": [ { "storageName": "string", "storageDirectory": { "directoryPath": "string" }, "storageFiles": [ { "filePath": "string", "fileSizeBytes": 0, "rowCount": 0 } ], "discoverStorageFiles": true } ], "attributes": [ { "name": "string", "value": "string" } ], "businessObjectDataParents": [ { "namespace": "string", "businessObjectDefinitionName": "string", "businessObjectFormatUsage": "string", "businessObjectFormatFileType": "string", "businessObjectFormatVersion": 0, "partitionValue": "string", "subPartitionValues": [ "string" ], "businessObjectDataVersion": 0 } ], "createNewVersion": true } Click to set as parameter value <?xml version="1.0" encoding="UTF-8"?> <businessObjectDataCreateRequest> <namespace>string</namespace> <businessObjectDefinitionName>string</businessObjectDefinitionName> <businessObjectFormatUsage>string</businessObjectFormatUsage> <businessObjectFormatFileType>string</businessObjectFormatFileType> <businessObjectFormatVersion>0</businessObjectFormatVersion> <partitionKey>string</partitionKey> <partitionValue>string</partitionValue> <subPartitionValues> <partitionValue>string</partitionValue> </subPartitionValues> <status>string</status> <storageUnits> <storageUnit> <storageName>string</storageName> <storageDirectory> <directoryPath>string</directoryPath> </storageDirectory> <storageFiles> <storageFile> <filePath>string</filePath> <fileSizeBytes>0</fileSizeBytes> <rowCount>0</rowCount> </storageFile> </storageFiles> <discoverStorageFiles>true</discoverStorageFiles> </storageUnit> </storageUnits> <attributes> <attribute> <name>string</name> <value>string</value> </attribute> </attributes> <businessObjectDataParents> <businessObjectDataKey> <namespace>string</namespace> <businessObjectDefinitionName>string</businessObjectDefinitionName> <businessObjectFormatUsage>string</businessObjectFormatUsage> <businessObjectFormatFileType>string</businessObjectFormatFileType> <businessObjectFormatVersion>0</businessObjectFormatVersion> <partitionValue>string</partitionValue> <subPartitionValues> <partitionValue>string</partitionValue> </subPartitionValues> <businessObjectDataVersion>0</businessObjectDataVersion> </businessObjectDataKey> </businessObjectDataParents> <createNewVersion>true</createNewVersion> </businessObjectDataCreateRequest> Click to set as parameter value

Response (Status 200)

businessObjectData {

id (integer, optional):

The internal Id that uniquely references the newly created Business Object Data

,

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionKey (string):

The Partition Key this Business Object Data is being registered with. This must be they Partition Key specified in the Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with this Business Object Data

,

version (integer, optional):

The numeric version of a Business Object Data. Each time a new data object is registered, the new version will be the previous version + 1

,

latestVersion (boolean, optional):

No longer in use A boolean flag that shows whether this instance of data is the latest or not. Once a new version of data is registered, any previous versions will no longer be the latest

,

status (string, optional):

The status of the Business Object Data. One of the following values: VALID, UPLOADING, PENDING_VALID, PROCESSING, INVALID, ARCHIVED, EXPIRED, or DELETED

,

storageUnits (Array[storageUnit], optional):

A container for the Storage Units associated with a Business Object Data

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage. Attributes values are required for certain keys that are defined as Attribute Definitions in the Business Object Format

,

businessObjectDataParents (Array[businessObjectDataKey], optional):

A list of Business Object Data parents (i.e. predecessors) that were used/needed in the creation of this data. This is used for data lineage. Each parent consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataChildren (Array[businessObjectDataKey], optional):

A list of Business Object Data children that were creation from this data. This is used for data lineage. Each child consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataStatusHistory (Array[businessObjectDataStatusChangeEvent], optional):

Lists all business object data status change events for this business object data

}
storageUnit {

storage (storage):

The Storage for this Storage Unit

,

storageDirectory (storageDirectory, optional):

A container for a Storage Directory that resides within a specific Storage Unit

,

storageFiles (Array[storageFile], optional):

A container of various Storage Files that reside within a specific Storage Unit

,

storageUnitStatus (string, optional):

The status of this Storage Unit. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}
businessObjectDataKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values this Business Object Data is associated with

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

}
businessObjectDataStatusChangeEvent {

status (string):

The status of the Business Object Data

,

eventTime (string):

The timestamp of when the business object data status change occurred

,

userId (string):

The User ID of the user who performed status update or registration of the Business Object Data

}
storage {

name (string):

Name of Storage

,

storagePlatformName (string):

Name of Storage Platform (eg S3) associated with this Storage

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage

}
storageDirectory {

directoryPath (string):

The fully qualified storage directory path

}
storageFile {

filePath (string):

The fully qualified file path to the data. When Storage Directory is specified, all Storage File paths should start with the Storage Directory path

,

fileSizeBytes (integer, optional):

The file size in bytes

,

rowCount (integer, optional):

The number of lines in the file

}

{
  "id": 0,
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "businessObjectFormatUsage": "string",
  "businessObjectFormatFileType": "string",
  "businessObjectFormatVersion": 0,
  "partitionKey": "string",
  "partitionValue": "string",
  "subPartitionValues": [
    "string"
  ],
  "version": 0,
  "latestVersion": true,
  "status": "string",
  "storageUnits": [
    {
      "storage": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<storage>\n   <name>string</name>\n   <storagePlatformName>string</storagePlatformName>\n   <attributes>\n      <attribute>\n         <name>string</name>\n         <value>string</value>\n      </attribute>\n   </attributes>\n</storage>\n",
      "storageDirectory": {
        "directoryPath": "string"
      },
      "storageFiles": [
        {
          "filePath": "string",
          "fileSizeBytes": 0,
          "rowCount": 0
        }
      ],
      "storageUnitStatus": "string"
    }
  ],
  "attributes": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "businessObjectDataParents": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0
    }
  ],
  "businessObjectDataChildren": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0
    }
  ],
  "businessObjectDataStatusHistory": [
    {
      "status": "string",
      "eventTime": "2017-04-29T14:40:26.505Z",
      "userId": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectData>
     <id>0</id>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <businessObjectFormatUsage>string</businessObjectFormatUsage>
     <businessObjectFormatFileType>string</businessObjectFormatFileType>
     <businessObjectFormatVersion>0</businessObjectFormatVersion>
     <partitionKey>string</partitionKey>
     <partitionValue>string</partitionValue>
     <subPartitionValues>
          <partitionValue>string</partitionValue>
     </subPartitionValues>
     <version>0</version>
     <latestVersion>true</latestVersion>
     <status>string</status>
     <storageUnits>
          <storageUnit>
               <storage>
                    <name>string</name>
                    <storagePlatformName>string</storagePlatformName>
                    <attributes>
                         <attribute>
                              <name>string</name>
                              <value>string</value>
                         </attribute>
                    </attributes>
               </storage>
               <storageDirectory>
                    <directoryPath>string</directoryPath>
               </storageDirectory>
               <storageFiles>
                    <storageFile>
                         <filePath>string</filePath>
                         <fileSizeBytes>0</fileSizeBytes>
                         <rowCount>0</rowCount>
                    </storageFile>
               </storageFiles>
               <storageUnitStatus>string</storageUnitStatus>
          </storageUnit>
     </storageUnits>
     <attributes>
          <attribute>
               <name>string</name>
               <value>string</value>
          </attribute>
     </attributes>
     <businessObjectDataParents>
          <businessObjectDataKey>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionValue>string</partitionValue>
               <subPartitionValues>
                    <partitionValue>string</partitionValue>
               </subPartitionValues>
               <businessObjectDataVersion>0</businessObjectDataVersion>
          </businessObjectDataKey>
     </businessObjectDataParents>
     <businessObjectDataChildren>
          <businessObjectDataKey>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionValue>string</partitionValue>
               <subPartitionValues>
                    <partitionValue>string</partitionValue>
               </subPartitionValues>
               <businessObjectDataVersion>0</businessObjectDataVersion>
          </businessObjectDataKey>
     </businessObjectDataChildren>
     <businessObjectDataStatusHistory>
          <businessObjectDataStatusChangeEvent>
               <status>string</status>
               <eventTime>2015-12-25T00:00:00.000-05:00</eventTime>
               <userId>string</userId>
          </businessObjectDataStatusChangeEvent>
     </businessObjectDataStatusHistory>
</businessObjectData>

Response Content Type

post /businessObjectData/availability

checkBusinessObjectDataAvailability

Implementation Notes

Performs a search and returns a list of business object data key values and relative statuses for a range of requested business object data.

Requires READ permission on namespace

Parameter (body): the business object data availability request
Parameter content type: Model JSON Schema XML Example businessObjectDataAvailabilityRequest { namespace (string): The Namespace to which a Business Object Format is related , businessObjectDefinitionName (string): The name of the Business Object Definition to which a Business Object Format is related , businessObjectFormatUsage (string): The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions , businessObjectFormatFileType (string): A File Type known to the system that describes the file type of data stored under a Business Object Format , businessObjectFormatVersion (integer, optional): The Business Object Format Version for a previously registered Business Object Format , partitionValueFilters (Array[partitionValueFilter], optional): A container for Partition Value Filters , partitionValueFilter (partitionValueFilter, optional): A container for the Partition Values to check for availability. The request must contain either a single partition value filter or up to 5 partition value filters when passed inside partitionValueFilters container. Only the Partition that is listed in the Business Object Format for this Business Object Data can be specified in a Partition Value Filter , businessObjectDataVersion (integer, optional): The numeric version of a Business Object Data , storageNames (Array[string], optional): A container for Storage Names to include when checking for Business Object Data availability , storageName (string, optional): Name of an existing storage known to the System. Required when StorageName is present , includeAllRegisteredSubPartitions (boolean, optional): Specifies to perform an exhaustive search to return availability for ALL registered sub-partitions (registered as individual business object data instances) except for the ones with "DELETED" status. This parameter has no impact when business object data version is specified. Default value is false, which means that availability ignores any "not available" registered sub-partitions when it finds at least one "VALID" registered sub-partitions for a requested business object data partition value } partitionValueFilter { partitionKey (string, optional): The Partition Key for a Business Object Data. This must be they Partition Key specified in the Business Object Format. Required when partitionValueFilters is present , partitionValues (Array[string], optional): This specifies a list of partition values. Required when partitionValueRange, latestBeforePartitionValue, or latestAfterPartitionValue is not present , partitionValueRange (partitionValueRange, optional): A container for the Partition Value Range. A Partition Key Group value is required in the Business Object Format in order to use a Partition Value Range when requesting to check the Business Object Data availability. The Partition Key Group value will be used to identify the ordered set of Expected Partition Values. For more information please see *LINK Business Object Format Post and* LINK Expected Partition Values Post. Only a single Partition Value Range is allowed per request. This value is required only when partitionValues, latestBeforePartitionValue, or latestAfterPartitionValue is not present , latestBeforePartitionValue (latestBeforePartitionValue, optional): This specifies that the availability request should return the latest Partition Value available before the specified Partition Value. If there is no available partition before the specified value, the response will not include any partitions. When Business Object Data Version is not specified, the Latest Before Partition Value for "VALID" business object data is returned back. This value is only required when partitionValues, partitionValueRange, or latestAfterPartitionValue is not present , latestAfterPartitionValue (latestAfterPartitionValue, optional): This specifies that the availability request should return the latest Partition Value available after the specified Partition Value. If there is no available partition after the specified value, the response will not include any partitions. When Business Object Data Version is not specified, the Latest Before Partition Value for "VALID" business object data is returned back. This value is only required when partitionValues, partitionValueRange, or latestAfterPartitionValue is not present } partitionValueRange { startPartitionValue (string): The start partition value for the partition value range. Required when partitionValueRange is present , endPartitionValue (string): The end partition value for the partition value range. Required when partitionValueRange is present } latestBeforePartitionValue { partitionValue (string): The partition value that is an inclusive upper bound for the latest available partition value. Required when latestBeforePartitionValue is present } latestAfterPartitionValue { partitionValue (string): The partition value that is an inclusive lower bound for the latest available partition value. Required when latestAfterPartitionValue is present } { "namespace": "string", "businessObjectDefinitionName": "string", "businessObjectFormatUsage": "string", "businessObjectFormatFileType": "string", "businessObjectFormatVersion": 0, "partitionValueFilters": [ { "partitionKey": "string", "partitionValues": [ "string" ], "partitionValueRange": { "startPartitionValue": "string", "endPartitionValue": "string" }, "latestBeforePartitionValue": { "partitionValue": "string" }, "latestAfterPartitionValue": { "partitionValue": "string" } } ], "partitionValueFilter": { "partitionKey": "string", "partitionValues": [ "string" ], "partitionValueRange": { "startPartitionValue": "string", "endPartitionValue": "string" }, "latestBeforePartitionValue": { "partitionValue": "string" }, "latestAfterPartitionValue": { "partitionValue": "string" } }, "businessObjectDataVersion": 0, "storageNames": [ "string" ], "storageName": "string", "includeAllRegisteredSubPartitions": true } Click to set as parameter value <?xml version="1.0" encoding="UTF-8"?> <businessObjectDataAvailabilityRequest> <namespace>string</namespace> <businessObjectDefinitionName>string</businessObjectDefinitionName> <businessObjectFormatUsage>string</businessObjectFormatUsage> <businessObjectFormatFileType>string</businessObjectFormatFileType> <businessObjectFormatVersion>0</businessObjectFormatVersion> <partitionValueFilters> <partitionValueFilter> <partitionKey>string</partitionKey> <partitionValues> <partitionValue>string</partitionValue> </partitionValues> <partitionValueRange> <startPartitionValue>string</startPartitionValue> <endPartitionValue>string</endPartitionValue> </partitionValueRange> <latestBeforePartitionValue> <partitionValue>string</partitionValue> </latestBeforePartitionValue> <latestAfterPartitionValue> <partitionValue>string</partitionValue> </latestAfterPartitionValue> </partitionValueFilter> </partitionValueFilters> <partitionValueFilter> <partitionKey>string</partitionKey> <partitionValues> <partitionValue>string</partitionValue> </partitionValues> <partitionValueRange> <startPartitionValue>string</startPartitionValue> <endPartitionValue>string</endPartitionValue> </partitionValueRange> <latestBeforePartitionValue> <partitionValue>string</partitionValue> </latestBeforePartitionValue> <latestAfterPartitionValue> <partitionValue>string</partitionValue> </latestAfterPartitionValue> </partitionValueFilter> <businessObjectDataVersion>0</businessObjectDataVersion> <storageNames> <storageName>string</storageName> </storageNames> <storageName>string</storageName> <includeAllRegisteredSubPartitions>true</includeAllRegisteredSubPartitions> </businessObjectDataAvailabilityRequest> Click to set as parameter value

Response (Status 200)

businessObjectDataAvailability {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValueFilters (Array[partitionValueFilter], optional):

A container for Partition Value Filters

,

partitionValueFilter (partitionValueFilter, optional):

A container for the Partition Values to check for availability. The request must contain either a single partition value filter or up to 5 partition value filters when passed inside partitionValueFilters container. Only the Partition that is listed in the Business Object Format for this Business Object Data can be specified in a Partition Value Filter

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

storageNames (Array[string], optional):

A container for Storage Names to include when checking for Business Object Data availability

,

storageName (string, optional):

Name of an existing storage known to the System. Required when StorageName is present

,

availableStatuses (Array[businessObjectDataStatus], optional):

A container for the Business Object Data in this query that are considered available

,

notAvailableStatuses (Array[businessObjectDataStatus], optional):

A container for the Business Object Data in this query that are not considered available

}
partitionValueFilter {

partitionKey (string, optional):

The Partition Key for a Business Object Data. This must be they Partition Key specified in the Business Object Format. Required when partitionValueFilters is present

,

partitionValues (Array[string], optional):

This specifies a list of partition values. Required when partitionValueRange, latestBeforePartitionValue, or latestAfterPartitionValue is not present

,

partitionValueRange (partitionValueRange, optional):

A container for the Partition Value Range. A Partition Key Group value is required in the Business Object Format in order to use a Partition Value Range when requesting to check the Business Object Data availability. The Partition Key Group value will be used to identify the ordered set of Expected Partition Values. For more information please see LINK Business Object Format Post and LINK Expected Partition Values Post. Only a single Partition Value Range is allowed per request. This value is required only when partitionValues, latestBeforePartitionValue, or latestAfterPartitionValue is not present

,

latestBeforePartitionValue (latestBeforePartitionValue, optional):

This specifies that the availability request should return the latest Partition Value available before the specified Partition Value. If there is no available partition before the specified value, the response will not include any partitions. When Business Object Data Version is not specified, the Latest Before Partition Value for "VALID" business object data is returned back. This value is only required when partitionValues, partitionValueRange, or latestAfterPartitionValue is not present

,

latestAfterPartitionValue (latestAfterPartitionValue, optional):

This specifies that the availability request should return the latest Partition Value available after the specified Partition Value. If there is no available partition after the specified value, the response will not include any partitions. When Business Object Data Version is not specified, the Latest Before Partition Value for "VALID" business object data is returned back. This value is only required when partitionValues, partitionValueRange, or latestAfterPartitionValue is not present

}
businessObjectDataStatus {

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The partition value that the Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with a Business Object Data

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

reason (string, optional):

A reason for the Business Object Data not being available (NOT_REGISTERED, INVALID, etc...)

}
partitionValueRange {

startPartitionValue (string):

The start partition value for the partition value range. Required when partitionValueRange is present

,

endPartitionValue (string):

The end partition value for the partition value range. Required when partitionValueRange is present

}
latestBeforePartitionValue {

partitionValue (string):

The partition value that is an inclusive upper bound for the latest available partition value. Required when latestBeforePartitionValue is present

}
latestAfterPartitionValue {

partitionValue (string):

The partition value that is an inclusive lower bound for the latest available partition value. Required when latestAfterPartitionValue is present

}

{
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "businessObjectFormatUsage": "string",
  "businessObjectFormatFileType": "string",
  "businessObjectFormatVersion": 0,
  "partitionValueFilters": [
    {
      "partitionKey": "string",
      "partitionValues": [
        "string"
      ],
      "partitionValueRange": {
        "startPartitionValue": "string",
        "endPartitionValue": "string"
      },
      "latestBeforePartitionValue": {
        "partitionValue": "string"
      },
      "latestAfterPartitionValue": {
        "partitionValue": "string"
      }
    }
  ],
  "partitionValueFilter": {
    "partitionKey": "string",
    "partitionValues": [
      "string"
    ],
    "partitionValueRange": {
      "startPartitionValue": "string",
      "endPartitionValue": "string"
    },
    "latestBeforePartitionValue": {
      "partitionValue": "string"
    },
    "latestAfterPartitionValue": {
      "partitionValue": "string"
    }
  },
  "businessObjectDataVersion": 0,
  "storageNames": [
    "string"
  ],
  "storageName": "string",
  "availableStatuses": [
    {
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0,
      "reason": "string"
    }
  ],
  "notAvailableStatuses": [
    {
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0,
      "reason": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataAvailability>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <businessObjectFormatUsage>string</businessObjectFormatUsage>
     <businessObjectFormatFileType>string</businessObjectFormatFileType>
     <businessObjectFormatVersion>0</businessObjectFormatVersion>
     <partitionValueFilters>
          <partitionValueFilter>
               <partitionKey>string</partitionKey>
               <partitionValues>
                    <partitionValue>string</partitionValue>
               </partitionValues>
               <partitionValueRange>
                    <startPartitionValue>string</startPartitionValue>
                    <endPartitionValue>string</endPartitionValue>
               </partitionValueRange>
               <latestBeforePartitionValue>
                    <partitionValue>string</partitionValue>
               </latestBeforePartitionValue>
               <latestAfterPartitionValue>
                    <partitionValue>string</partitionValue>
               </latestAfterPartitionValue>
          </partitionValueFilter>
     </partitionValueFilters>
     <partitionValueFilter>
          <partitionKey>string</partitionKey>
          <partitionValues>
               <partitionValue>string</partitionValue>
          </partitionValues>
          <partitionValueRange>
               <startPartitionValue>string</startPartitionValue>
               <endPartitionValue>string</endPartitionValue>
          </partitionValueRange>
          <latestBeforePartitionValue>
               <partitionValue>string</partitionValue>
          </latestBeforePartitionValue>
          <latestAfterPartitionValue>
               <partitionValue>string</partitionValue>
          </latestAfterPartitionValue>
     </partitionValueFilter>
     <businessObjectDataVersion>0</businessObjectDataVersion>
     <storageNames>
          <storageName>string</storageName>
     </storageNames>
     <storageName>string</storageName>
     <availableStatuses>
          <businessObjectDataStatus>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionValue>string</partitionValue>
               <subPartitionValues>
                    <partitionValue>string</partitionValue>
               </subPartitionValues>
               <businessObjectDataVersion>0</businessObjectDataVersion>
               <reason>string</reason>
          </businessObjectDataStatus>
     </availableStatuses>
     <notAvailableStatuses>
          <businessObjectDataStatus>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionValue>string</partitionValue>
               <subPartitionValues>
                    <partitionValue>string</partitionValue>
               </subPartitionValues>
               <businessObjectDataVersion>0</businessObjectDataVersion>
               <reason>string</reason>
          </businessObjectDataStatus>
     </notAvailableStatuses>
</businessObjectDataAvailability>

Response Content Type

post /businessObjectData/availabilityCollection

checkBusinessObjectDataAvailabilityCollection

Implementation Notes

Performs an availability check for a collection of business object data.

Requires READ permission on ALL namespaces

Parameter (body): the business object data availability collection request
Parameter content type: Model JSON Schema XML Example businessObjectDataAvailabilityCollectionRequest { businessObjectDataAvailabilityRequests (Array[businessObjectDataAvailabilityRequest], optional): A container for multiple availability requests } businessObjectDataAvailabilityRequest { namespace (string): The Namespace to which a Business Object Format is related , businessObjectDefinitionName (string): The name of the Business Object Definition to which a Business Object Format is related , businessObjectFormatUsage (string): The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions , businessObjectFormatFileType (string): A File Type known to the system that describes the file type of data stored under a Business Object Format , businessObjectFormatVersion (integer, optional): The Business Object Format Version for a previously registered Business Object Format , partitionValueFilters (Array[partitionValueFilter], optional): A container for Partition Value Filters , partitionValueFilter (partitionValueFilter, optional): A container for the Partition Values to check for availability. The request must contain either a single partition value filter or up to 5 partition value filters when passed inside partitionValueFilters container. Only the Partition that is listed in the Business Object Format for this Business Object Data can be specified in a Partition Value Filter , businessObjectDataVersion (integer, optional): The numeric version of a Business Object Data , storageNames (Array[string], optional): A container for Storage Names to include when checking for Business Object Data availability , storageName (string, optional): Name of an existing storage known to the System. Required when StorageName is present , includeAllRegisteredSubPartitions (boolean, optional): Specifies to perform an exhaustive search to return availability for ALL registered sub-partitions (registered as individual business object data instances) except for the ones with "DELETED" status. This parameter has no impact when business object data version is specified. Default value is false, which means that availability ignores any "not available" registered sub-partitions when it finds at least one "VALID" registered sub-partitions for a requested business object data partition value } partitionValueFilter { partitionKey (string, optional): The Partition Key for a Business Object Data. This must be they Partition Key specified in the Business Object Format. Required when partitionValueFilters is present , partitionValues (Array[string], optional): This specifies a list of partition values. Required when partitionValueRange, latestBeforePartitionValue, or latestAfterPartitionValue is not present , partitionValueRange (partitionValueRange, optional): A container for the Partition Value Range. A Partition Key Group value is required in the Business Object Format in order to use a Partition Value Range when requesting to check the Business Object Data availability. The Partition Key Group value will be used to identify the ordered set of Expected Partition Values. For more information please see *LINK Business Object Format Post and* LINK Expected Partition Values Post. Only a single Partition Value Range is allowed per request. This value is required only when partitionValues, latestBeforePartitionValue, or latestAfterPartitionValue is not present , latestBeforePartitionValue (latestBeforePartitionValue, optional): This specifies that the availability request should return the latest Partition Value available before the specified Partition Value. If there is no available partition before the specified value, the response will not include any partitions. When Business Object Data Version is not specified, the Latest Before Partition Value for "VALID" business object data is returned back. This value is only required when partitionValues, partitionValueRange, or latestAfterPartitionValue is not present , latestAfterPartitionValue (latestAfterPartitionValue, optional): This specifies that the availability request should return the latest Partition Value available after the specified Partition Value. If there is no available partition after the specified value, the response will not include any partitions. When Business Object Data Version is not specified, the Latest Before Partition Value for "VALID" business object data is returned back. This value is only required when partitionValues, partitionValueRange, or latestAfterPartitionValue is not present } partitionValueRange { startPartitionValue (string): The start partition value for the partition value range. Required when partitionValueRange is present , endPartitionValue (string): The end partition value for the partition value range. Required when partitionValueRange is present } latestBeforePartitionValue { partitionValue (string): The partition value that is an inclusive upper bound for the latest available partition value. Required when latestBeforePartitionValue is present } latestAfterPartitionValue { partitionValue (string): The partition value that is an inclusive lower bound for the latest available partition value. Required when latestAfterPartitionValue is present } { "businessObjectDataAvailabilityRequests": [ "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<businessObjectDataAvailabilityRequest>\n <namespace>string</namespace>\n <businessObjectDefinitionName>string</businessObjectDefinitionName>\n <businessObjectFormatUsage>string</businessObjectFormatUsage>\n <businessObjectFormatFileType>string</businessObjectFormatFileType>\n <businessObjectFormatVersion>0</businessObjectFormatVersion>\n <partitionValueFilters>\n <partitionValueFilter>\n <partitionKey>string</partitionKey>\n <partitionValues>\n <partitionValue>string</partitionValue>\n </partitionValues>\n <partitionValueRange>\n <startPartitionValue>string</startPartitionValue>\n <endPartitionValue>string</endPartitionValue>\n </partitionValueRange>\n <latestBeforePartitionValue>\n <partitionValue>string</partitionValue>\n </latestBeforePartitionValue>\n <latestAfterPartitionValue>\n <partitionValue>string</partitionValue>\n </latestAfterPartitionValue>\n </partitionValueFilter>\n </partitionValueFilters>\n <partitionValueFilter>\n <partitionKey>string</partitionKey>\n <partitionValues>\n <partitionValue>string</partitionValue>\n </partitionValues>\n <partitionValueRange>\n <startPartitionValue>string</startPartitionValue>\n <endPartitionValue>string</endPartitionValue>\n </partitionValueRange>\n <latestBeforePartitionValue>\n <partitionValue>string</partitionValue>\n </latestBeforePartitionValue>\n <latestAfterPartitionValue>\n <partitionValue>string</partitionValue>\n </latestAfterPartitionValue>\n </partitionValueFilter>\n <businessObjectDataVersion>0</businessObjectDataVersion>\n <storageNames>\n <storageName>string</storageName>\n </storageNames>\n <storageName>string</storageName>\n <includeAllRegisteredSubPartitions>true</includeAllRegisteredSubPartitions>\n</businessObjectDataAvailabilityRequest>\n" ] } Click to set as parameter value <?xml version="1.0" encoding="UTF-8"?> <businessObjectDataAvailabilityCollectionRequest> <businessObjectDataAvailabilityRequests> <businessObjectDataAvailabilityRequest> <namespace>string</namespace> <businessObjectDefinitionName>string</businessObjectDefinitionName> <businessObjectFormatUsage>string</businessObjectFormatUsage> <businessObjectFormatFileType>string</businessObjectFormatFileType> <businessObjectFormatVersion>0</businessObjectFormatVersion> <partitionValueFilters> <partitionValueFilter> <partitionKey>string</partitionKey> <partitionValues> <partitionValue>string</partitionValue> </partitionValues> <partitionValueRange> <startPartitionValue>string</startPartitionValue> <endPartitionValue>string</endPartitionValue> </partitionValueRange> <latestBeforePartitionValue> <partitionValue>string</partitionValue> </latestBeforePartitionValue> <latestAfterPartitionValue> <partitionValue>string</partitionValue> </latestAfterPartitionValue> </partitionValueFilter> </partitionValueFilters> <partitionValueFilter> <partitionKey>string</partitionKey> <partitionValues> <partitionValue>string</partitionValue> </partitionValues> <partitionValueRange> <startPartitionValue>string</startPartitionValue> <endPartitionValue>string</endPartitionValue> </partitionValueRange> <latestBeforePartitionValue> <partitionValue>string</partitionValue> </latestBeforePartitionValue> <latestAfterPartitionValue> <partitionValue>string</partitionValue> </latestAfterPartitionValue> </partitionValueFilter> <businessObjectDataVersion>0</businessObjectDataVersion> <storageNames> <storageName>string</storageName> </storageNames> <storageName>string</storageName> <includeAllRegisteredSubPartitions>true</includeAllRegisteredSubPartitions> </businessObjectDataAvailabilityRequest> </businessObjectDataAvailabilityRequests> </businessObjectDataAvailabilityCollectionRequest> Click to set as parameter value

Response (Status 200)

businessObjectDataAvailabilityCollectionResponse {

businessObjectDataAvailabilityResponses (Array[businessObjectDataAvailability], optional):

A container for the availability responses

,

isAllDataAvailable (boolean, optional):

Aggregate response indicating if all of the data covered in all requests in the collection is available

,

isAllDataNotAvailable (boolean, optional):

Aggregate response indicating if none of the data covered in any request in the collection is available

}
businessObjectDataAvailability {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValueFilters (Array[partitionValueFilter], optional):

A container for Partition Value Filters

,

partitionValueFilter (partitionValueFilter, optional):

A container for the Partition Values to check for availability. The request must contain either a single partition value filter or up to 5 partition value filters when passed inside partitionValueFilters container. Only the Partition that is listed in the Business Object Format for this Business Object Data can be specified in a Partition Value Filter

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

storageNames (Array[string], optional):

A container for Storage Names to include when checking for Business Object Data availability

,

storageName (string, optional):

Name of an existing storage known to the System. Required when StorageName is present

,

availableStatuses (Array[businessObjectDataStatus], optional):

A container for the Business Object Data in this query that are considered available

,

notAvailableStatuses (Array[businessObjectDataStatus], optional):

A container for the Business Object Data in this query that are not considered available

}
partitionValueFilter {

partitionKey (string, optional):

The Partition Key for a Business Object Data. This must be they Partition Key specified in the Business Object Format. Required when partitionValueFilters is present

,

partitionValues (Array[string], optional):

This specifies a list of partition values. Required when partitionValueRange, latestBeforePartitionValue, or latestAfterPartitionValue is not present

,

partitionValueRange (partitionValueRange, optional):

A container for the Partition Value Range. A Partition Key Group value is required in the Business Object Format in order to use a Partition Value Range when requesting to check the Business Object Data availability. The Partition Key Group value will be used to identify the ordered set of Expected Partition Values. For more information please see LINK Business Object Format Post and LINK Expected Partition Values Post. Only a single Partition Value Range is allowed per request. This value is required only when partitionValues, latestBeforePartitionValue, or latestAfterPartitionValue is not present

,

latestBeforePartitionValue (latestBeforePartitionValue, optional):

This specifies that the availability request should return the latest Partition Value available before the specified Partition Value. If there is no available partition before the specified value, the response will not include any partitions. When Business Object Data Version is not specified, the Latest Before Partition Value for "VALID" business object data is returned back. This value is only required when partitionValues, partitionValueRange, or latestAfterPartitionValue is not present

,

latestAfterPartitionValue (latestAfterPartitionValue, optional):

This specifies that the availability request should return the latest Partition Value available after the specified Partition Value. If there is no available partition after the specified value, the response will not include any partitions. When Business Object Data Version is not specified, the Latest Before Partition Value for "VALID" business object data is returned back. This value is only required when partitionValues, partitionValueRange, or latestAfterPartitionValue is not present

}
businessObjectDataStatus {

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The partition value that the Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with a Business Object Data

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

reason (string, optional):

A reason for the Business Object Data not being available (NOT_REGISTERED, INVALID, etc...)

}
partitionValueRange {

startPartitionValue (string):

The start partition value for the partition value range. Required when partitionValueRange is present

,

endPartitionValue (string):

The end partition value for the partition value range. Required when partitionValueRange is present

}
latestBeforePartitionValue {

partitionValue (string):

The partition value that is an inclusive upper bound for the latest available partition value. Required when latestBeforePartitionValue is present

}
latestAfterPartitionValue {

partitionValue (string):

The partition value that is an inclusive lower bound for the latest available partition value. Required when latestAfterPartitionValue is present

}

{
  "businessObjectDataAvailabilityResponses": [
    "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<businessObjectDataAvailability>\n   <namespace>string</namespace>\n   <businessObjectDefinitionName>string</businessObjectDefinitionName>\n   <businessObjectFormatUsage>string</businessObjectFormatUsage>\n   <businessObjectFormatFileType>string</businessObjectFormatFileType>\n   <businessObjectFormatVersion>0</businessObjectFormatVersion>\n   <partitionValueFilters>\n      <partitionValueFilter>\n         <partitionKey>string</partitionKey>\n         <partitionValues>\n            <partitionValue>string</partitionValue>\n         </partitionValues>\n         <partitionValueRange>\n            <startPartitionValue>string</startPartitionValue>\n            <endPartitionValue>string</endPartitionValue>\n         </partitionValueRange>\n         <latestBeforePartitionValue>\n            <partitionValue>string</partitionValue>\n         </latestBeforePartitionValue>\n         <latestAfterPartitionValue>\n            <partitionValue>string</partitionValue>\n         </latestAfterPartitionValue>\n      </partitionValueFilter>\n   </partitionValueFilters>\n   <partitionValueFilter>\n      <partitionKey>string</partitionKey>\n      <partitionValues>\n         <partitionValue>string</partitionValue>\n      </partitionValues>\n      <partitionValueRange>\n         <startPartitionValue>string</startPartitionValue>\n         <endPartitionValue>string</endPartitionValue>\n      </partitionValueRange>\n      <latestBeforePartitionValue>\n         <partitionValue>string</partitionValue>\n      </latestBeforePartitionValue>\n      <latestAfterPartitionValue>\n         <partitionValue>string</partitionValue>\n      </latestAfterPartitionValue>\n   </partitionValueFilter>\n   <businessObjectDataVersion>0</businessObjectDataVersion>\n   <storageNames>\n      <storageName>string</storageName>\n   </storageNames>\n   <storageName>string</storageName>\n   <availableStatuses>\n      <businessObjectDataStatus>\n         <businessObjectFormatVersion>0</businessObjectFormatVersion>\n         <partitionValue>string</partitionValue>\n         <subPartitionValues>\n            <partitionValue>string</partitionValue>\n         </subPartitionValues>\n         <businessObjectDataVersion>0</businessObjectDataVersion>\n         <reason>string</reason>\n      </businessObjectDataStatus>\n   </availableStatuses>\n   <notAvailableStatuses>\n      <businessObjectDataStatus>\n         <businessObjectFormatVersion>0</businessObjectFormatVersion>\n         <partitionValue>string</partitionValue>\n         <subPartitionValues>\n            <partitionValue>string</partitionValue>\n         </subPartitionValues>\n         <businessObjectDataVersion>0</businessObjectDataVersion>\n         <reason>string</reason>\n      </businessObjectDataStatus>\n   </notAvailableStatuses>\n</businessObjectDataAvailability>\n"
  ],
  "isAllDataAvailable": true,
  "isAllDataNotAvailable": true
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataAvailabilityCollectionResponse>
     <businessObjectDataAvailabilityResponses>
          <businessObjectDataAvailability>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionValueFilters>
                    <partitionValueFilter>
                         <partitionKey>string</partitionKey>
                         <partitionValues>
                              <partitionValue>string</partitionValue>
                         </partitionValues>
                         <partitionValueRange>
                              <startPartitionValue>string</startPartitionValue>
                              <endPartitionValue>string</endPartitionValue>
                         </partitionValueRange>
                         <latestBeforePartitionValue>
                              <partitionValue>string</partitionValue>
                         </latestBeforePartitionValue>
                         <latestAfterPartitionValue>
                              <partitionValue>string</partitionValue>
                         </latestAfterPartitionValue>
                    </partitionValueFilter>
               </partitionValueFilters>
               <partitionValueFilter>
                    <partitionKey>string</partitionKey>
                    <partitionValues>
                         <partitionValue>string</partitionValue>
                    </partitionValues>
                    <partitionValueRange>
                         <startPartitionValue>string</startPartitionValue>
                         <endPartitionValue>string</endPartitionValue>
                    </partitionValueRange>
                    <latestBeforePartitionValue>
                         <partitionValue>string</partitionValue>
                    </latestBeforePartitionValue>
                    <latestAfterPartitionValue>
                         <partitionValue>string</partitionValue>
                    </latestAfterPartitionValue>
               </partitionValueFilter>
               <businessObjectDataVersion>0</businessObjectDataVersion>
               <storageNames>
                    <storageName>string</storageName>
               </storageNames>
               <storageName>string</storageName>
               <availableStatuses>
                    <businessObjectDataStatus>
                         <businessObjectFormatVersion>0</businessObjectFormatVersion>
                         <partitionValue>string</partitionValue>
                         <subPartitionValues>
                              <partitionValue>string</partitionValue>
                         </subPartitionValues>
                         <businessObjectDataVersion>0</businessObjectDataVersion>
                         <reason>string</reason>
                    </businessObjectDataStatus>
               </availableStatuses>
               <notAvailableStatuses>
                    <businessObjectDataStatus>
                         <businessObjectFormatVersion>0</businessObjectFormatVersion>
                         <partitionValue>string</partitionValue>
                         <subPartitionValues>
                              <partitionValue>string</partitionValue>
                         </subPartitionValues>
                         <businessObjectDataVersion>0</businessObjectDataVersion>
                         <reason>string</reason>
                    </businessObjectDataStatus>
               </notAvailableStatuses>
          </businessObjectDataAvailability>
     </businessObjectDataAvailabilityResponses>
     <isAllDataAvailable>true</isAllDataAvailable>
     <isAllDataNotAvailable>true</isAllDataNotAvailable>
</businessObjectDataAvailabilityCollectionResponse>

Response Content Type

post /businessObjectData/generateDdl

generateBusinessObjectDataDdl

Implementation Notes

Retrieves the DDL to initialize the specified type of the database system to perform queries for a range of requested business object data in the specified storage.

Requires READ permission on namespace

Parameter (body): the business object data DDL request

Parameter content type:

businessObjectDataDdlRequest {

namespace (string),

businessObjectDefinitionName (string),

businessObjectFormatUsage (string),

businessObjectFormatFileType (string),

businessObjectFormatVersion (integer, optional),

partitionValueFilters (Array[partitionValueFilter], optional),

partitionValueFilter (partitionValueFilter, optional),

businessObjectDataVersion (integer, optional),

storageNames (Array[string], optional),

storageName (string, optional),

outputFormat (string) = ['HIVE_13_DDL']

string
Enum:	"HIVE_13_DDL"

,

tableName (string),

customDdlName (string, optional),

includeDropTableStatement (boolean, optional),

includeIfNotExistsOption (boolean, optional),

includeDropPartitions (boolean, optional),

allowMissingData (boolean, optional),

includeAllRegisteredSubPartitions (boolean, optional):

Specifies to perform an exhaustive search to return availability for ALL registered sub-partitions (registered as individual business object data instances) except for the ones with "DELETED" status. This parameter has no impact when business object data version is specified. Default value is false, which means that this endpoint ignores any "not available" registered sub-partitions when it finds at least one "VALID" registered sub-partitions for a requested business object data partition value

}
partitionValueFilter {

partitionKey (string, optional):

The Partition Key for a Business Object Data. This must be they Partition Key specified in the Business Object Format. Required when partitionValueFilters is present

,

partitionValues (Array[string], optional):

This specifies a list of partition values. Required when partitionValueRange, latestBeforePartitionValue, or latestAfterPartitionValue is not present

,

partitionValueRange (partitionValueRange, optional):

A container for the Partition Value Range. A Partition Key Group value is required in the Business Object Format in order to use a Partition Value Range when requesting to check the Business Object Data availability. The Partition Key Group value will be used to identify the ordered set of Expected Partition Values. For more information please see LINK Business Object Format Post and LINK Expected Partition Values Post. Only a single Partition Value Range is allowed per request. This value is required only when partitionValues, latestBeforePartitionValue, or latestAfterPartitionValue is not present

,

latestBeforePartitionValue (latestBeforePartitionValue, optional):

This specifies that the availability request should return the latest Partition Value available before the specified Partition Value. If there is no available partition before the specified value, the response will not include any partitions. When Business Object Data Version is not specified, the Latest Before Partition Value for "VALID" business object data is returned back. This value is only required when partitionValues, partitionValueRange, or latestAfterPartitionValue is not present

,

latestAfterPartitionValue (latestAfterPartitionValue, optional):

This specifies that the availability request should return the latest Partition Value available after the specified Partition Value. If there is no available partition after the specified value, the response will not include any partitions. When Business Object Data Version is not specified, the Latest Before Partition Value for "VALID" business object data is returned back. This value is only required when partitionValues, partitionValueRange, or latestAfterPartitionValue is not present

}
partitionValueRange {

startPartitionValue (string):

The start partition value for the partition value range. Required when partitionValueRange is present

,

endPartitionValue (string):

The end partition value for the partition value range. Required when partitionValueRange is present

}
latestBeforePartitionValue {

partitionValue (string):

The partition value that is an inclusive upper bound for the latest available partition value. Required when latestBeforePartitionValue is present

}
latestAfterPartitionValue {

partitionValue (string):

The partition value that is an inclusive lower bound for the latest available partition value. Required when latestAfterPartitionValue is present

}

{
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "businessObjectFormatUsage": "string",
  "businessObjectFormatFileType": "string",
  "businessObjectFormatVersion": 0,
  "partitionValueFilters": [
    {
      "partitionKey": "string",
      "partitionValues": [
        "string"
      ],
      "partitionValueRange": {
        "startPartitionValue": "string",
        "endPartitionValue": "string"
      },
      "latestBeforePartitionValue": {
        "partitionValue": "string"
      },
      "latestAfterPartitionValue": {
        "partitionValue": "string"
      }
    }
  ],
  "partitionValueFilter": {
    "partitionKey": "string",
    "partitionValues": [
      "string"
    ],
    "partitionValueRange": {
      "startPartitionValue": "string",
      "endPartitionValue": "string"
    },
    "latestBeforePartitionValue": {
      "partitionValue": "string"
    },
    "latestAfterPartitionValue": {
      "partitionValue": "string"
    }
  },
  "businessObjectDataVersion": 0,
  "storageNames": [
    "string"
  ],
  "storageName": "string",
  "outputFormat": "HIVE_13_DDL",
  "tableName": "string",
  "customDdlName": "string",
  "includeDropTableStatement": true,
  "includeIfNotExistsOption": true,
  "includeDropPartitions": true,
  "allowMissingData": true,
  "includeAllRegisteredSubPartitions": true
}

Click to set as parameter value

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataDdlRequest>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <businessObjectFormatUsage>string</businessObjectFormatUsage>
     <businessObjectFormatFileType>string</businessObjectFormatFileType>
     <businessObjectFormatVersion>0</businessObjectFormatVersion>
     <partitionValueFilters>
          <partitionValueFilter>
               <partitionKey>string</partitionKey>
               <partitionValues>
                    <partitionValue>string</partitionValue>
               </partitionValues>
               <partitionValueRange>
                    <startPartitionValue>string</startPartitionValue>
                    <endPartitionValue>string</endPartitionValue>
               </partitionValueRange>
               <latestBeforePartitionValue>
                    <partitionValue>string</partitionValue>
               </latestBeforePartitionValue>
               <latestAfterPartitionValue>
                    <partitionValue>string</partitionValue>
               </latestAfterPartitionValue>
          </partitionValueFilter>
     </partitionValueFilters>
     <partitionValueFilter>
          <partitionKey>string</partitionKey>
          <partitionValues>
               <partitionValue>string</partitionValue>
          </partitionValues>
          <partitionValueRange>
               <startPartitionValue>string</startPartitionValue>
               <endPartitionValue>string</endPartitionValue>
          </partitionValueRange>
          <latestBeforePartitionValue>
               <partitionValue>string</partitionValue>
          </latestBeforePartitionValue>
          <latestAfterPartitionValue>
               <partitionValue>string</partitionValue>
          </latestAfterPartitionValue>
     </partitionValueFilter>
     <businessObjectDataVersion>0</businessObjectDataVersion>
     <storageNames>
          <storageName>string</storageName>
     </storageNames>
     <storageName>string</storageName>
     <outputFormat>HIVE_13_DDL</outputFormat>
     <tableName>string</tableName>
     <customDdlName>string</customDdlName>
     <includeDropTableStatement>true</includeDropTableStatement>
     <includeIfNotExistsOption>true</includeIfNotExistsOption>
     <includeDropPartitions>true</includeDropPartitions>
     <allowMissingData>true</allowMissingData>
     <includeAllRegisteredSubPartitions>true</includeAllRegisteredSubPartitions>
</businessObjectDataDdlRequest>

Click to set as parameter value

Response (Status 200)

businessObjectDataDdl {

namespace (string),

businessObjectDefinitionName (string),

businessObjectFormatUsage (string),

businessObjectFormatFileType (string),

businessObjectFormatVersion (integer, optional),

partitionValueFilters (Array[partitionValueFilter], optional),

partitionValueFilter (partitionValueFilter, optional),

businessObjectDataVersion (integer, optional),

storageNames (Array[string], optional),

storageName (string, optional),

outputFormat (string) = ['HIVE_13_DDL']

string
Enum:	"HIVE_13_DDL"

,

tableName (string),

customDdlName (string, optional),

ddl (string)

}
partitionValueFilter {

partitionKey (string, optional):

The Partition Key for a Business Object Data. This must be they Partition Key specified in the Business Object Format. Required when partitionValueFilters is present

,

partitionValues (Array[string], optional):

This specifies a list of partition values. Required when partitionValueRange, latestBeforePartitionValue, or latestAfterPartitionValue is not present

,

partitionValueRange (partitionValueRange, optional):

A container for the Partition Value Range. A Partition Key Group value is required in the Business Object Format in order to use a Partition Value Range when requesting to check the Business Object Data availability. The Partition Key Group value will be used to identify the ordered set of Expected Partition Values. For more information please see LINK Business Object Format Post and LINK Expected Partition Values Post. Only a single Partition Value Range is allowed per request. This value is required only when partitionValues, latestBeforePartitionValue, or latestAfterPartitionValue is not present

,

latestBeforePartitionValue (latestBeforePartitionValue, optional):

This specifies that the availability request should return the latest Partition Value available before the specified Partition Value. If there is no available partition before the specified value, the response will not include any partitions. When Business Object Data Version is not specified, the Latest Before Partition Value for "VALID" business object data is returned back. This value is only required when partitionValues, partitionValueRange, or latestAfterPartitionValue is not present

,

latestAfterPartitionValue (latestAfterPartitionValue, optional):

This specifies that the availability request should return the latest Partition Value available after the specified Partition Value. If there is no available partition after the specified value, the response will not include any partitions. When Business Object Data Version is not specified, the Latest Before Partition Value for "VALID" business object data is returned back. This value is only required when partitionValues, partitionValueRange, or latestAfterPartitionValue is not present

}
partitionValueRange {

startPartitionValue (string):

The start partition value for the partition value range. Required when partitionValueRange is present

,

endPartitionValue (string):

The end partition value for the partition value range. Required when partitionValueRange is present

}
latestBeforePartitionValue {

partitionValue (string):

The partition value that is an inclusive upper bound for the latest available partition value. Required when latestBeforePartitionValue is present

}
latestAfterPartitionValue {

partitionValue (string):

The partition value that is an inclusive lower bound for the latest available partition value. Required when latestAfterPartitionValue is present

}

{
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "businessObjectFormatUsage": "string",
  "businessObjectFormatFileType": "string",
  "businessObjectFormatVersion": 0,
  "partitionValueFilters": [
    {
      "partitionKey": "string",
      "partitionValues": [
        "string"
      ],
      "partitionValueRange": {
        "startPartitionValue": "string",
        "endPartitionValue": "string"
      },
      "latestBeforePartitionValue": {
        "partitionValue": "string"
      },
      "latestAfterPartitionValue": {
        "partitionValue": "string"
      }
    }
  ],
  "partitionValueFilter": {
    "partitionKey": "string",
    "partitionValues": [
      "string"
    ],
    "partitionValueRange": {
      "startPartitionValue": "string",
      "endPartitionValue": "string"
    },
    "latestBeforePartitionValue": {
      "partitionValue": "string"
    },
    "latestAfterPartitionValue": {
      "partitionValue": "string"
    }
  },
  "businessObjectDataVersion": 0,
  "storageNames": [
    "string"
  ],
  "storageName": "string",
  "outputFormat": "HIVE_13_DDL",
  "tableName": "string",
  "customDdlName": "string",
  "ddl": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataDdl>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <businessObjectFormatUsage>string</businessObjectFormatUsage>
     <businessObjectFormatFileType>string</businessObjectFormatFileType>
     <businessObjectFormatVersion>0</businessObjectFormatVersion>
     <partitionValueFilters>
          <partitionValueFilter>
               <partitionKey>string</partitionKey>
               <partitionValues>
                    <partitionValue>string</partitionValue>
               </partitionValues>
               <partitionValueRange>
                    <startPartitionValue>string</startPartitionValue>
                    <endPartitionValue>string</endPartitionValue>
               </partitionValueRange>
               <latestBeforePartitionValue>
                    <partitionValue>string</partitionValue>
               </latestBeforePartitionValue>
               <latestAfterPartitionValue>
                    <partitionValue>string</partitionValue>
               </latestAfterPartitionValue>
          </partitionValueFilter>
     </partitionValueFilters>
     <partitionValueFilter>
          <partitionKey>string</partitionKey>
          <partitionValues>
               <partitionValue>string</partitionValue>
          </partitionValues>
          <partitionValueRange>
               <startPartitionValue>string</startPartitionValue>
               <endPartitionValue>string</endPartitionValue>
          </partitionValueRange>
          <latestBeforePartitionValue>
               <partitionValue>string</partitionValue>
          </latestBeforePartitionValue>
          <latestAfterPartitionValue>
               <partitionValue>string</partitionValue>
          </latestAfterPartitionValue>
     </partitionValueFilter>
     <businessObjectDataVersion>0</businessObjectDataVersion>
     <storageNames>
          <storageName>string</storageName>
     </storageNames>
     <storageName>string</storageName>
     <outputFormat>HIVE_13_DDL</outputFormat>
     <tableName>string</tableName>
     <customDdlName>string</customDdlName>
     <ddl>
    <![CDATA[
    string]]>
  </ddl>
</businessObjectDataDdl>

Response Content Type

post /businessObjectData/generateDdlCollection

generateBusinessObjectDataDdlCollection

Implementation Notes

Retrieves the DDL to initialize the specified type of the database system to perform queries for a collection of business object data in the specified storage.

Requires READ permission on ALL namespaces

Parameter (body): the business object data DDL collection request

Parameter content type:

businessObjectDataDdlCollectionRequest {

businessObjectDataDdlRequests (Array[businessObjectDataDdlRequest], optional)

}
businessObjectDataDdlRequest {

namespace (string),

businessObjectDefinitionName (string),

businessObjectFormatUsage (string),

businessObjectFormatFileType (string),

businessObjectFormatVersion (integer, optional),

partitionValueFilters (Array[partitionValueFilter], optional),

partitionValueFilter (partitionValueFilter, optional),

businessObjectDataVersion (integer, optional),

storageNames (Array[string], optional),

storageName (string, optional),

outputFormat (string) = ['HIVE_13_DDL']

string
Enum:	"HIVE_13_DDL"

,

tableName (string),

customDdlName (string, optional),

includeDropTableStatement (boolean, optional),

includeIfNotExistsOption (boolean, optional),

includeDropPartitions (boolean, optional),

allowMissingData (boolean, optional),

includeAllRegisteredSubPartitions (boolean, optional):

Specifies to perform an exhaustive search to return availability for ALL registered sub-partitions (registered as individual business object data instances) except for the ones with "DELETED" status. This parameter has no impact when business object data version is specified. Default value is false, which means that this endpoint ignores any "not available" registered sub-partitions when it finds at least one "VALID" registered sub-partitions for a requested business object data partition value

}
partitionValueFilter {

partitionKey (string, optional):

The Partition Key for a Business Object Data. This must be they Partition Key specified in the Business Object Format. Required when partitionValueFilters is present

,

partitionValues (Array[string], optional):

This specifies a list of partition values. Required when partitionValueRange, latestBeforePartitionValue, or latestAfterPartitionValue is not present

,

partitionValueRange (partitionValueRange, optional):

A container for the Partition Value Range. A Partition Key Group value is required in the Business Object Format in order to use a Partition Value Range when requesting to check the Business Object Data availability. The Partition Key Group value will be used to identify the ordered set of Expected Partition Values. For more information please see LINK Business Object Format Post and LINK Expected Partition Values Post. Only a single Partition Value Range is allowed per request. This value is required only when partitionValues, latestBeforePartitionValue, or latestAfterPartitionValue is not present

,

latestBeforePartitionValue (latestBeforePartitionValue, optional):

This specifies that the availability request should return the latest Partition Value available before the specified Partition Value. If there is no available partition before the specified value, the response will not include any partitions. When Business Object Data Version is not specified, the Latest Before Partition Value for "VALID" business object data is returned back. This value is only required when partitionValues, partitionValueRange, or latestAfterPartitionValue is not present

,

latestAfterPartitionValue (latestAfterPartitionValue, optional):

This specifies that the availability request should return the latest Partition Value available after the specified Partition Value. If there is no available partition after the specified value, the response will not include any partitions. When Business Object Data Version is not specified, the Latest Before Partition Value for "VALID" business object data is returned back. This value is only required when partitionValues, partitionValueRange, or latestAfterPartitionValue is not present

}
partitionValueRange {

startPartitionValue (string):

The start partition value for the partition value range. Required when partitionValueRange is present

,

endPartitionValue (string):

The end partition value for the partition value range. Required when partitionValueRange is present

}
latestBeforePartitionValue {

partitionValue (string):

The partition value that is an inclusive upper bound for the latest available partition value. Required when latestBeforePartitionValue is present

}
latestAfterPartitionValue {

partitionValue (string):

The partition value that is an inclusive lower bound for the latest available partition value. Required when latestAfterPartitionValue is present

}

{
  "businessObjectDataDdlRequests": [
    "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<businessObjectDataDdlRequest>\n   <namespace>string</namespace>\n   <businessObjectDefinitionName>string</businessObjectDefinitionName>\n   <businessObjectFormatUsage>string</businessObjectFormatUsage>\n   <businessObjectFormatFileType>string</businessObjectFormatFileType>\n   <businessObjectFormatVersion>0</businessObjectFormatVersion>\n   <partitionValueFilters>\n      <partitionValueFilter>\n         <partitionKey>string</partitionKey>\n         <partitionValues>\n            <partitionValue>string</partitionValue>\n         </partitionValues>\n         <partitionValueRange>\n            <startPartitionValue>string</startPartitionValue>\n            <endPartitionValue>string</endPartitionValue>\n         </partitionValueRange>\n         <latestBeforePartitionValue>\n            <partitionValue>string</partitionValue>\n         </latestBeforePartitionValue>\n         <latestAfterPartitionValue>\n            <partitionValue>string</partitionValue>\n         </latestAfterPartitionValue>\n      </partitionValueFilter>\n   </partitionValueFilters>\n   <partitionValueFilter>\n      <partitionKey>string</partitionKey>\n      <partitionValues>\n         <partitionValue>string</partitionValue>\n      </partitionValues>\n      <partitionValueRange>\n         <startPartitionValue>string</startPartitionValue>\n         <endPartitionValue>string</endPartitionValue>\n      </partitionValueRange>\n      <latestBeforePartitionValue>\n         <partitionValue>string</partitionValue>\n      </latestBeforePartitionValue>\n      <latestAfterPartitionValue>\n         <partitionValue>string</partitionValue>\n      </latestAfterPartitionValue>\n   </partitionValueFilter>\n   <businessObjectDataVersion>0</businessObjectDataVersion>\n   <storageNames>\n      <storageName>string</storageName>\n   </storageNames>\n   <storageName>string</storageName>\n   <outputFormat>HIVE_13_DDL</outputFormat>\n   <tableName>string</tableName>\n   <customDdlName>string</customDdlName>\n   <includeDropTableStatement>true</includeDropTableStatement>\n   <includeIfNotExistsOption>true</includeIfNotExistsOption>\n   <includeDropPartitions>true</includeDropPartitions>\n   <allowMissingData>true</allowMissingData>\n   <includeAllRegisteredSubPartitions>true</includeAllRegisteredSubPartitions>\n</businessObjectDataDdlRequest>\n"
  ]
}

Click to set as parameter value

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataDdlCollectionRequest>
     <businessObjectDataDdlRequests>
          <businessObjectDataDdlRequest>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionValueFilters>
                    <partitionValueFilter>
                         <partitionKey>string</partitionKey>
                         <partitionValues>
                              <partitionValue>string</partitionValue>
                         </partitionValues>
                         <partitionValueRange>
                              <startPartitionValue>string</startPartitionValue>
                              <endPartitionValue>string</endPartitionValue>
                         </partitionValueRange>
                         <latestBeforePartitionValue>
                              <partitionValue>string</partitionValue>
                         </latestBeforePartitionValue>
                         <latestAfterPartitionValue>
                              <partitionValue>string</partitionValue>
                         </latestAfterPartitionValue>
                    </partitionValueFilter>
               </partitionValueFilters>
               <partitionValueFilter>
                    <partitionKey>string</partitionKey>
                    <partitionValues>
                         <partitionValue>string</partitionValue>
                    </partitionValues>
                    <partitionValueRange>
                         <startPartitionValue>string</startPartitionValue>
                         <endPartitionValue>string</endPartitionValue>
                    </partitionValueRange>
                    <latestBeforePartitionValue>
                         <partitionValue>string</partitionValue>
                    </latestBeforePartitionValue>
                    <latestAfterPartitionValue>
                         <partitionValue>string</partitionValue>
                    </latestAfterPartitionValue>
               </partitionValueFilter>
               <businessObjectDataVersion>0</businessObjectDataVersion>
               <storageNames>
                    <storageName>string</storageName>
               </storageNames>
               <storageName>string</storageName>
               <outputFormat>HIVE_13_DDL</outputFormat>
               <tableName>string</tableName>
               <customDdlName>string</customDdlName>
               <includeDropTableStatement>true</includeDropTableStatement>
               <includeIfNotExistsOption>true</includeIfNotExistsOption>
               <includeDropPartitions>true</includeDropPartitions>
               <allowMissingData>true</allowMissingData>
               <includeAllRegisteredSubPartitions>true</includeAllRegisteredSubPartitions>
          </businessObjectDataDdlRequest>
     </businessObjectDataDdlRequests>
</businessObjectDataDdlCollectionRequest>

Click to set as parameter value

Response (Status 200)

businessObjectDataDdlCollectionResponse {

businessObjectDataDdlResponses (Array[businessObjectDataDdl], optional),

ddlCollection (string)

}
businessObjectDataDdl {

namespace (string),

businessObjectDefinitionName (string),

businessObjectFormatUsage (string),

businessObjectFormatFileType (string),

businessObjectFormatVersion (integer, optional),

partitionValueFilters (Array[partitionValueFilter], optional),

partitionValueFilter (partitionValueFilter, optional),

businessObjectDataVersion (integer, optional),

storageNames (Array[string], optional),

storageName (string, optional),

outputFormat (string) = ['HIVE_13_DDL']

string
Enum:	"HIVE_13_DDL"

,

tableName (string),

customDdlName (string, optional),

ddl (string)

}
partitionValueFilter {

partitionKey (string, optional):

The Partition Key for a Business Object Data. This must be they Partition Key specified in the Business Object Format. Required when partitionValueFilters is present

,

partitionValues (Array[string], optional):

This specifies a list of partition values. Required when partitionValueRange, latestBeforePartitionValue, or latestAfterPartitionValue is not present

,

partitionValueRange (partitionValueRange, optional):

A container for the Partition Value Range. A Partition Key Group value is required in the Business Object Format in order to use a Partition Value Range when requesting to check the Business Object Data availability. The Partition Key Group value will be used to identify the ordered set of Expected Partition Values. For more information please see LINK Business Object Format Post and LINK Expected Partition Values Post. Only a single Partition Value Range is allowed per request. This value is required only when partitionValues, latestBeforePartitionValue, or latestAfterPartitionValue is not present

,

latestBeforePartitionValue (latestBeforePartitionValue, optional):

This specifies that the availability request should return the latest Partition Value available before the specified Partition Value. If there is no available partition before the specified value, the response will not include any partitions. When Business Object Data Version is not specified, the Latest Before Partition Value for "VALID" business object data is returned back. This value is only required when partitionValues, partitionValueRange, or latestAfterPartitionValue is not present

,

latestAfterPartitionValue (latestAfterPartitionValue, optional):

This specifies that the availability request should return the latest Partition Value available after the specified Partition Value. If there is no available partition after the specified value, the response will not include any partitions. When Business Object Data Version is not specified, the Latest Before Partition Value for "VALID" business object data is returned back. This value is only required when partitionValues, partitionValueRange, or latestAfterPartitionValue is not present

}
partitionValueRange {

startPartitionValue (string):

The start partition value for the partition value range. Required when partitionValueRange is present

,

endPartitionValue (string):

The end partition value for the partition value range. Required when partitionValueRange is present

}
latestBeforePartitionValue {

partitionValue (string):

The partition value that is an inclusive upper bound for the latest available partition value. Required when latestBeforePartitionValue is present

}
latestAfterPartitionValue {

partitionValue (string):

The partition value that is an inclusive lower bound for the latest available partition value. Required when latestAfterPartitionValue is present

}

{
  "businessObjectDataDdlResponses": [
    "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<businessObjectDataDdl>\n   <namespace>string</namespace>\n   <businessObjectDefinitionName>string</businessObjectDefinitionName>\n   <businessObjectFormatUsage>string</businessObjectFormatUsage>\n   <businessObjectFormatFileType>string</businessObjectFormatFileType>\n   <businessObjectFormatVersion>0</businessObjectFormatVersion>\n   <partitionValueFilters>\n      <partitionValueFilter>\n         <partitionKey>string</partitionKey>\n         <partitionValues>\n            <partitionValue>string</partitionValue>\n         </partitionValues>\n         <partitionValueRange>\n            <startPartitionValue>string</startPartitionValue>\n            <endPartitionValue>string</endPartitionValue>\n         </partitionValueRange>\n         <latestBeforePartitionValue>\n            <partitionValue>string</partitionValue>\n         </latestBeforePartitionValue>\n         <latestAfterPartitionValue>\n            <partitionValue>string</partitionValue>\n         </latestAfterPartitionValue>\n      </partitionValueFilter>\n   </partitionValueFilters>\n   <partitionValueFilter>\n      <partitionKey>string</partitionKey>\n      <partitionValues>\n         <partitionValue>string</partitionValue>\n      </partitionValues>\n      <partitionValueRange>\n         <startPartitionValue>string</startPartitionValue>\n         <endPartitionValue>string</endPartitionValue>\n      </partitionValueRange>\n      <latestBeforePartitionValue>\n         <partitionValue>string</partitionValue>\n      </latestBeforePartitionValue>\n      <latestAfterPartitionValue>\n         <partitionValue>string</partitionValue>\n      </latestAfterPartitionValue>\n   </partitionValueFilter>\n   <businessObjectDataVersion>0</businessObjectDataVersion>\n   <storageNames>\n      <storageName>string</storageName>\n   </storageNames>\n   <storageName>string</storageName>\n   <outputFormat>HIVE_13_DDL</outputFormat>\n   <tableName>string</tableName>\n   <customDdlName>string</customDdlName>\n   <ddl><![CDATA[string]]></ddl>\n</businessObjectDataDdl>\n"
  ],
  "ddlCollection": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataDdlCollectionResponse>
     <businessObjectDataDdlResponses>
          <businessObjectDataDdl>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionValueFilters>
                    <partitionValueFilter>
                         <partitionKey>string</partitionKey>
                         <partitionValues>
                              <partitionValue>string</partitionValue>
                         </partitionValues>
                         <partitionValueRange>
                              <startPartitionValue>string</startPartitionValue>
                              <endPartitionValue>string</endPartitionValue>
                         </partitionValueRange>
                         <latestBeforePartitionValue>
                              <partitionValue>string</partitionValue>
                         </latestBeforePartitionValue>
                         <latestAfterPartitionValue>
                              <partitionValue>string</partitionValue>
                         </latestAfterPartitionValue>
                    </partitionValueFilter>
               </partitionValueFilters>
               <partitionValueFilter>
                    <partitionKey>string</partitionKey>
                    <partitionValues>
                         <partitionValue>string</partitionValue>
                    </partitionValues>
                    <partitionValueRange>
                         <startPartitionValue>string</startPartitionValue>
                         <endPartitionValue>string</endPartitionValue>
                    </partitionValueRange>
                    <latestBeforePartitionValue>
                         <partitionValue>string</partitionValue>
                    </latestBeforePartitionValue>
                    <latestAfterPartitionValue>
                         <partitionValue>string</partitionValue>
                    </latestAfterPartitionValue>
               </partitionValueFilter>
               <businessObjectDataVersion>0</businessObjectDataVersion>
               <storageNames>
                    <storageName>string</storageName>
               </storageNames>
               <storageName>string</storageName>
               <outputFormat>HIVE_13_DDL</outputFormat>
               <tableName>string</tableName>
               <customDdlName>string</customDdlName>
               <ddl>
        <![CDATA[
        string]]>
      </ddl>
          </businessObjectDataDdl>
     </businessObjectDataDdlResponses>
     <ddlCollection>
    <![CDATA[
    string]]>
  </ddlCollection>
</businessObjectDataDdlCollectionResponse>

Response Content Type

get /businessObjectData/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}

getBusinessObjectData

Implementation Notes

Retrieves existing business object data entry information.

NOTE: When both business object format version and business object data version are not specified, the business object format version has the precedence. The latest business object format version is determined by a sub-query, which does the following:

selects all available data for the specified business object format (disregarding business object format version), partition values, and business object data status (default is "VALID")
gets the latest business object format version from the records selected in the previous step

Requires READ permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
partitionKey	the partition key of the business object format. When specified, the partition key is validated against the partition key associated with the relative business object format	query	string
partitionValue	the partition value of the business object data	query	string
subPartitionValues	the list of sub-partition values delimited by "\|" (delimiter can be escaped by "\")	query	string
businessObjectFormatVersion	the version of the business object format. When the business object format version is not specified, the business object data with the latest business format version available for the specified partition values is returned	query	integer
businessObjectDataVersion	the version of the business object data. When business object data version is not specified, the latest version of business object data of the specified business object data status is returned	query	integer
businessObjectDataStatus	the status of the business object data. When business object data version is specified, this parameter is ignored. Default value is "VALID"	query	string
includeBusinessObjectDataStatusHistory	specifies to include business object data status history in the response	query	boolean

Response (Status 200)

businessObjectData {

id (integer, optional):

The internal Id that uniquely references the newly created Business Object Data

,

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionKey (string):

The Partition Key this Business Object Data is being registered with. This must be they Partition Key specified in the Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with this Business Object Data

,

version (integer, optional):

The numeric version of a Business Object Data. Each time a new data object is registered, the new version will be the previous version + 1

,

latestVersion (boolean, optional):

No longer in use A boolean flag that shows whether this instance of data is the latest or not. Once a new version of data is registered, any previous versions will no longer be the latest

,

status (string, optional):

The status of the Business Object Data. One of the following values: VALID, UPLOADING, PENDING_VALID, PROCESSING, INVALID, ARCHIVED, EXPIRED, or DELETED

,

storageUnits (Array[storageUnit], optional):

A container for the Storage Units associated with a Business Object Data

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage. Attributes values are required for certain keys that are defined as Attribute Definitions in the Business Object Format

,

businessObjectDataParents (Array[businessObjectDataKey], optional):

A list of Business Object Data parents (i.e. predecessors) that were used/needed in the creation of this data. This is used for data lineage. Each parent consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataChildren (Array[businessObjectDataKey], optional):

A list of Business Object Data children that were creation from this data. This is used for data lineage. Each child consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataStatusHistory (Array[businessObjectDataStatusChangeEvent], optional):

Lists all business object data status change events for this business object data

}
storageUnit {

storage (storage):

The Storage for this Storage Unit

,

storageDirectory (storageDirectory, optional):

A container for a Storage Directory that resides within a specific Storage Unit

,

storageFiles (Array[storageFile], optional):

A container of various Storage Files that reside within a specific Storage Unit

,

storageUnitStatus (string, optional):

The status of this Storage Unit. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}
businessObjectDataKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values this Business Object Data is associated with

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

}
businessObjectDataStatusChangeEvent {

status (string):

The status of the Business Object Data

,

eventTime (string):

The timestamp of when the business object data status change occurred

,

userId (string):

The User ID of the user who performed status update or registration of the Business Object Data

}
storage {

name (string):

Name of Storage

,

storagePlatformName (string):

Name of Storage Platform (eg S3) associated with this Storage

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage

}
storageDirectory {

directoryPath (string):

The fully qualified storage directory path

}
storageFile {

filePath (string):

The fully qualified file path to the data. When Storage Directory is specified, all Storage File paths should start with the Storage Directory path

,

fileSizeBytes (integer, optional):

The file size in bytes

,

rowCount (integer, optional):

The number of lines in the file

}

{
  "id": 0,
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "businessObjectFormatUsage": "string",
  "businessObjectFormatFileType": "string",
  "businessObjectFormatVersion": 0,
  "partitionKey": "string",
  "partitionValue": "string",
  "subPartitionValues": [
    "string"
  ],
  "version": 0,
  "latestVersion": true,
  "status": "string",
  "storageUnits": [
    {
      "storage": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<storage>\n   <name>string</name>\n   <storagePlatformName>string</storagePlatformName>\n   <attributes>\n      <attribute>\n         <name>string</name>\n         <value>string</value>\n      </attribute>\n   </attributes>\n</storage>\n",
      "storageDirectory": {
        "directoryPath": "string"
      },
      "storageFiles": [
        {
          "filePath": "string",
          "fileSizeBytes": 0,
          "rowCount": 0
        }
      ],
      "storageUnitStatus": "string"
    }
  ],
  "attributes": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "businessObjectDataParents": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0
    }
  ],
  "businessObjectDataChildren": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0
    }
  ],
  "businessObjectDataStatusHistory": [
    {
      "status": "string",
      "eventTime": "2017-04-29T14:40:26.537Z",
      "userId": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectData>
     <id>0</id>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <businessObjectFormatUsage>string</businessObjectFormatUsage>
     <businessObjectFormatFileType>string</businessObjectFormatFileType>
     <businessObjectFormatVersion>0</businessObjectFormatVersion>
     <partitionKey>string</partitionKey>
     <partitionValue>string</partitionValue>
     <subPartitionValues>
          <partitionValue>string</partitionValue>
     </subPartitionValues>
     <version>0</version>
     <latestVersion>true</latestVersion>
     <status>string</status>
     <storageUnits>
          <storageUnit>
               <storage>
                    <name>string</name>
                    <storagePlatformName>string</storagePlatformName>
                    <attributes>
                         <attribute>
                              <name>string</name>
                              <value>string</value>
                         </attribute>
                    </attributes>
               </storage>
               <storageDirectory>
                    <directoryPath>string</directoryPath>
               </storageDirectory>
               <storageFiles>
                    <storageFile>
                         <filePath>string</filePath>
                         <fileSizeBytes>0</fileSizeBytes>
                         <rowCount>0</rowCount>
                    </storageFile>
               </storageFiles>
               <storageUnitStatus>string</storageUnitStatus>
          </storageUnit>
     </storageUnits>
     <attributes>
          <attribute>
               <name>string</name>
               <value>string</value>
          </attribute>
     </attributes>
     <businessObjectDataParents>
          <businessObjectDataKey>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionValue>string</partitionValue>
               <subPartitionValues>
                    <partitionValue>string</partitionValue>
               </subPartitionValues>
               <businessObjectDataVersion>0</businessObjectDataVersion>
          </businessObjectDataKey>
     </businessObjectDataParents>
     <businessObjectDataChildren>
          <businessObjectDataKey>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionValue>string</partitionValue>
               <subPartitionValues>
                    <partitionValue>string</partitionValue>
               </subPartitionValues>
               <businessObjectDataVersion>0</businessObjectDataVersion>
          </businessObjectDataKey>
     </businessObjectDataChildren>
     <businessObjectDataStatusHistory>
          <businessObjectDataStatusChangeEvent>
               <status>string</status>
               <eventTime>2015-12-25T00:00:00.000-05:00</eventTime>
               <userId>string</userId>
          </businessObjectDataStatusChangeEvent>
     </businessObjectDataStatusHistory>
</businessObjectData>

Response Content Type

delete /businessObjectData/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/businessObjectDataVersions/{businessObjectDataVersion}

deleteBusinessObjectData

Implementation Notes

Deletes an existing business object data without subpartition values with namespace.

Requires WRITE permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
partitionValue	the partition value	path	string
businessObjectDataVersion	the business object data version	path	integer
deleteFiles	whether files should be deleted	query	boolean

Response (Status 200)

businessObjectData {

id (integer, optional):

The internal Id that uniquely references the newly created Business Object Data

,

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionKey (string):

The Partition Key this Business Object Data is being registered with. This must be they Partition Key specified in the Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with this Business Object Data

,

version (integer, optional):

The numeric version of a Business Object Data. Each time a new data object is registered, the new version will be the previous version + 1

,

latestVersion (boolean, optional):

No longer in use A boolean flag that shows whether this instance of data is the latest or not. Once a new version of data is registered, any previous versions will no longer be the latest

,

status (string, optional):

The status of the Business Object Data. One of the following values: VALID, UPLOADING, PENDING_VALID, PROCESSING, INVALID, ARCHIVED, EXPIRED, or DELETED

,

storageUnits (Array[storageUnit], optional):

A container for the Storage Units associated with a Business Object Data

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage. Attributes values are required for certain keys that are defined as Attribute Definitions in the Business Object Format

,

businessObjectDataParents (Array[businessObjectDataKey], optional):

A list of Business Object Data parents (i.e. predecessors) that were used/needed in the creation of this data. This is used for data lineage. Each parent consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataChildren (Array[businessObjectDataKey], optional):

A list of Business Object Data children that were creation from this data. This is used for data lineage. Each child consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataStatusHistory (Array[businessObjectDataStatusChangeEvent], optional):

Lists all business object data status change events for this business object data

}
storageUnit {

storage (storage):

The Storage for this Storage Unit

,

storageDirectory (storageDirectory, optional):

A container for a Storage Directory that resides within a specific Storage Unit

,

storageFiles (Array[storageFile], optional):

A container of various Storage Files that reside within a specific Storage Unit

,

storageUnitStatus (string, optional):

The status of this Storage Unit. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}
businessObjectDataKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values this Business Object Data is associated with

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

}
businessObjectDataStatusChangeEvent {

status (string):

The status of the Business Object Data

,

eventTime (string):

The timestamp of when the business object data status change occurred

,

userId (string):

The User ID of the user who performed status update or registration of the Business Object Data

}
storage {

name (string):

Name of Storage

,

storagePlatformName (string):

Name of Storage Platform (eg S3) associated with this Storage

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage

}
storageDirectory {

directoryPath (string):

The fully qualified storage directory path

}
storageFile {

filePath (string):

The fully qualified file path to the data. When Storage Directory is specified, all Storage File paths should start with the Storage Directory path

,

fileSizeBytes (integer, optional):

The file size in bytes

,

rowCount (integer, optional):

The number of lines in the file

}

{
  "id": 0,
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "businessObjectFormatUsage": "string",
  "businessObjectFormatFileType": "string",
  "businessObjectFormatVersion": 0,
  "partitionKey": "string",
  "partitionValue": "string",
  "subPartitionValues": [
    "string"
  ],
  "version": 0,
  "latestVersion": true,
  "status": "string",
  "storageUnits": [
    {
      "storage": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<storage>\n   <name>string</name>\n   <storagePlatformName>string</storagePlatformName>\n   <attributes>\n      <attribute>\n         <name>string</name>\n         <value>string</value>\n      </attribute>\n   </attributes>\n</storage>\n",
      "storageDirectory": {
        "directoryPath": "string"
      },
      "storageFiles": [
        {
          "filePath": "string",
          "fileSizeBytes": 0,
          "rowCount": 0
        }
      ],
      "storageUnitStatus": "string"
    }
  ],
  "attributes": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "businessObjectDataParents": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0
    }
  ],
  "businessObjectDataChildren": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0
    }
  ],
  "businessObjectDataStatusHistory": [
    {
      "status": "string",
      "eventTime": "2017-04-29T14:40:26.548Z",
      "userId": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectData>
     <id>0</id>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <businessObjectFormatUsage>string</businessObjectFormatUsage>
     <businessObjectFormatFileType>string</businessObjectFormatFileType>
     <businessObjectFormatVersion>0</businessObjectFormatVersion>
     <partitionKey>string</partitionKey>
     <partitionValue>string</partitionValue>
     <subPartitionValues>
          <partitionValue>string</partitionValue>
     </subPartitionValues>
     <version>0</version>
     <latestVersion>true</latestVersion>
     <status>string</status>
     <storageUnits>
          <storageUnit>
               <storage>
                    <name>string</name>
                    <storagePlatformName>string</storagePlatformName>
                    <attributes>
                         <attribute>
                              <name>string</name>
                              <value>string</value>
                         </attribute>
                    </attributes>
               </storage>
               <storageDirectory>
                    <directoryPath>string</directoryPath>
               </storageDirectory>
               <storageFiles>
                    <storageFile>
                         <filePath>string</filePath>
                         <fileSizeBytes>0</fileSizeBytes>
                         <rowCount>0</rowCount>
                    </storageFile>
               </storageFiles>
               <storageUnitStatus>string</storageUnitStatus>
          </storageUnit>
     </storageUnits>
     <attributes>
          <attribute>
               <name>string</name>
               <value>string</value>
          </attribute>
     </attributes>
     <businessObjectDataParents>
          <businessObjectDataKey>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionValue>string</partitionValue>
               <subPartitionValues>
                    <partitionValue>string</partitionValue>
               </subPartitionValues>
               <businessObjectDataVersion>0</businessObjectDataVersion>
          </businessObjectDataKey>
     </businessObjectDataParents>
     <businessObjectDataChildren>
          <businessObjectDataKey>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionValue>string</partitionValue>
               <subPartitionValues>
                    <partitionValue>string</partitionValue>
               </subPartitionValues>
               <businessObjectDataVersion>0</businessObjectDataVersion>
          </businessObjectDataKey>
     </businessObjectDataChildren>
     <businessObjectDataStatusHistory>
          <businessObjectDataStatusChangeEvent>
               <status>string</status>
               <eventTime>2015-12-25T00:00:00.000-05:00</eventTime>
               <userId>string</userId>
          </businessObjectDataStatusChangeEvent>
     </businessObjectDataStatusHistory>
</businessObjectData>

Response Content Type

delete /businessObjectData/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/businessObjectDataVersions/{businessObjectDataVersion}

deleteBusinessObjectData

Implementation Notes

Deletes an existing business object data with 1 subpartition value with namespace.

Requires WRITE permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace.	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
partitionValue	the partition value	path	string
subPartition1Value	sub-partition value 1	path	string
businessObjectDataVersion	the business object data version	path	integer
deleteFiles	whether files should be deleted	query	boolean

Response (Status 200)

businessObjectData {

id (integer, optional):

The internal Id that uniquely references the newly created Business Object Data

,

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionKey (string):

The Partition Key this Business Object Data is being registered with. This must be they Partition Key specified in the Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with this Business Object Data

,

version (integer, optional):

The numeric version of a Business Object Data. Each time a new data object is registered, the new version will be the previous version + 1

,

latestVersion (boolean, optional):

No longer in use A boolean flag that shows whether this instance of data is the latest or not. Once a new version of data is registered, any previous versions will no longer be the latest

,

status (string, optional):

The status of the Business Object Data. One of the following values: VALID, UPLOADING, PENDING_VALID, PROCESSING, INVALID, ARCHIVED, EXPIRED, or DELETED

,

storageUnits (Array[storageUnit], optional):

A container for the Storage Units associated with a Business Object Data

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage. Attributes values are required for certain keys that are defined as Attribute Definitions in the Business Object Format

,

businessObjectDataParents (Array[businessObjectDataKey], optional):

A list of Business Object Data parents (i.e. predecessors) that were used/needed in the creation of this data. This is used for data lineage. Each parent consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataChildren (Array[businessObjectDataKey], optional):

A list of Business Object Data children that were creation from this data. This is used for data lineage. Each child consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataStatusHistory (Array[businessObjectDataStatusChangeEvent], optional):

Lists all business object data status change events for this business object data

}
storageUnit {

storage (storage):

The Storage for this Storage Unit

,

storageDirectory (storageDirectory, optional):

A container for a Storage Directory that resides within a specific Storage Unit

,

storageFiles (Array[storageFile], optional):

A container of various Storage Files that reside within a specific Storage Unit

,

storageUnitStatus (string, optional):

The status of this Storage Unit. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}
businessObjectDataKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values this Business Object Data is associated with

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

}
businessObjectDataStatusChangeEvent {

status (string):

The status of the Business Object Data

,

eventTime (string):

The timestamp of when the business object data status change occurred

,

userId (string):

The User ID of the user who performed status update or registration of the Business Object Data

}
storage {

name (string):

Name of Storage

,

storagePlatformName (string):

Name of Storage Platform (eg S3) associated with this Storage

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage

}
storageDirectory {

directoryPath (string):

The fully qualified storage directory path

}
storageFile {

filePath (string):

The fully qualified file path to the data. When Storage Directory is specified, all Storage File paths should start with the Storage Directory path

,

fileSizeBytes (integer, optional):

The file size in bytes

,

rowCount (integer, optional):

The number of lines in the file

}

{
  "id": 0,
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "businessObjectFormatUsage": "string",
  "businessObjectFormatFileType": "string",
  "businessObjectFormatVersion": 0,
  "partitionKey": "string",
  "partitionValue": "string",
  "subPartitionValues": [
    "string"
  ],
  "version": 0,
  "latestVersion": true,
  "status": "string",
  "storageUnits": [
    {
      "storage": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<storage>\n   <name>string</name>\n   <storagePlatformName>string</storagePlatformName>\n   <attributes>\n      <attribute>\n         <name>string</name>\n         <value>string</value>\n      </attribute>\n   </attributes>\n</storage>\n",
      "storageDirectory": {
        "directoryPath": "string"
      },
      "storageFiles": [
        {
          "filePath": "string",
          "fileSizeBytes": 0,
          "rowCount": 0
        }
      ],
      "storageUnitStatus": "string"
    }
  ],
  "attributes": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "businessObjectDataParents": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0
    }
  ],
  "businessObjectDataChildren": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0
    }
  ],
  "businessObjectDataStatusHistory": [
    {
      "status": "string",
      "eventTime": "2017-04-29T14:40:26.555Z",
      "userId": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectData>
     <id>0</id>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <businessObjectFormatUsage>string</businessObjectFormatUsage>
     <businessObjectFormatFileType>string</businessObjectFormatFileType>
     <businessObjectFormatVersion>0</businessObjectFormatVersion>
     <partitionKey>string</partitionKey>
     <partitionValue>string</partitionValue>
     <subPartitionValues>
          <partitionValue>string</partitionValue>
     </subPartitionValues>
     <version>0</version>
     <latestVersion>true</latestVersion>
     <status>string</status>
     <storageUnits>
          <storageUnit>
               <storage>
                    <name>string</name>
                    <storagePlatformName>string</storagePlatformName>
                    <attributes>
                         <attribute>
                              <name>string</name>
                              <value>string</value>
                         </attribute>
                    </attributes>
               </storage>
               <storageDirectory>
                    <directoryPath>string</directoryPath>
               </storageDirectory>
               <storageFiles>
                    <storageFile>
                         <filePath>string</filePath>
                         <fileSizeBytes>0</fileSizeBytes>
                         <rowCount>0</rowCount>
                    </storageFile>
               </storageFiles>
               <storageUnitStatus>string</storageUnitStatus>
          </storageUnit>
     </storageUnits>
     <attributes>
          <attribute>
               <name>string</name>
               <value>string</value>
          </attribute>
     </attributes>
     <businessObjectDataParents>
          <businessObjectDataKey>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionValue>string</partitionValue>
               <subPartitionValues>
                    <partitionValue>string</partitionValue>
               </subPartitionValues>
               <businessObjectDataVersion>0</businessObjectDataVersion>
          </businessObjectDataKey>
     </businessObjectDataParents>
     <businessObjectDataChildren>
          <businessObjectDataKey>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionValue>string</partitionValue>
               <subPartitionValues>
                    <partitionValue>string</partitionValue>
               </subPartitionValues>
               <businessObjectDataVersion>0</businessObjectDataVersion>
          </businessObjectDataKey>
     </businessObjectDataChildren>
     <businessObjectDataStatusHistory>
          <businessObjectDataStatusChangeEvent>
               <status>string</status>
               <eventTime>2015-12-25T00:00:00.000-05:00</eventTime>
               <userId>string</userId>
          </businessObjectDataStatusChangeEvent>
     </businessObjectDataStatusHistory>
</businessObjectData>

Response Content Type

delete /businessObjectData/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/subPartition2Values/{subPartition2Value}/businessObjectDataVersions/{businessObjectDataVersion}

deleteBusinessObjectData

Implementation Notes

Deletes an existing business object data with 2 subpartition values with namespace.

Requires WRITE permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
partitionValue	the partition value	path	string
subPartition1Value	sub-partition value 1	path	string
subPartition2Value	sub-partition value 2	path	string
businessObjectDataVersion	the business object data version	path	integer
deleteFiles	whether files should be deleted	query	boolean

Response (Status 200)

businessObjectData {

id (integer, optional):

The internal Id that uniquely references the newly created Business Object Data

,

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionKey (string):

The Partition Key this Business Object Data is being registered with. This must be they Partition Key specified in the Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with this Business Object Data

,

version (integer, optional):

The numeric version of a Business Object Data. Each time a new data object is registered, the new version will be the previous version + 1

,

latestVersion (boolean, optional):

No longer in use A boolean flag that shows whether this instance of data is the latest or not. Once a new version of data is registered, any previous versions will no longer be the latest

,

status (string, optional):

The status of the Business Object Data. One of the following values: VALID, UPLOADING, PENDING_VALID, PROCESSING, INVALID, ARCHIVED, EXPIRED, or DELETED

,

storageUnits (Array[storageUnit], optional):

A container for the Storage Units associated with a Business Object Data

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage. Attributes values are required for certain keys that are defined as Attribute Definitions in the Business Object Format

,

businessObjectDataParents (Array[businessObjectDataKey], optional):

A list of Business Object Data parents (i.e. predecessors) that were used/needed in the creation of this data. This is used for data lineage. Each parent consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataChildren (Array[businessObjectDataKey], optional):

A list of Business Object Data children that were creation from this data. This is used for data lineage. Each child consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataStatusHistory (Array[businessObjectDataStatusChangeEvent], optional):

Lists all business object data status change events for this business object data

}
storageUnit {

storage (storage):

The Storage for this Storage Unit

,

storageDirectory (storageDirectory, optional):

A container for a Storage Directory that resides within a specific Storage Unit

,

storageFiles (Array[storageFile], optional):

A container of various Storage Files that reside within a specific Storage Unit

,

storageUnitStatus (string, optional):

The status of this Storage Unit. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}
businessObjectDataKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values this Business Object Data is associated with

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

}
businessObjectDataStatusChangeEvent {

status (string):

The status of the Business Object Data

,

eventTime (string):

The timestamp of when the business object data status change occurred

,

userId (string):

The User ID of the user who performed status update or registration of the Business Object Data

}
storage {

name (string):

Name of Storage

,

storagePlatformName (string):

Name of Storage Platform (eg S3) associated with this Storage

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage

}
storageDirectory {

directoryPath (string):

The fully qualified storage directory path

}
storageFile {

filePath (string):

The fully qualified file path to the data. When Storage Directory is specified, all Storage File paths should start with the Storage Directory path

,

fileSizeBytes (integer, optional):

The file size in bytes

,

rowCount (integer, optional):

The number of lines in the file

}

{
  "id": 0,
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "businessObjectFormatUsage": "string",
  "businessObjectFormatFileType": "string",
  "businessObjectFormatVersion": 0,
  "partitionKey": "string",
  "partitionValue": "string",
  "subPartitionValues": [
    "string"
  ],
  "version": 0,
  "latestVersion": true,
  "status": "string",
  "storageUnits": [
    {
      "storage": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<storage>\n   <name>string</name>\n   <storagePlatformName>string</storagePlatformName>\n   <attributes>\n      <attribute>\n         <name>string</name>\n         <value>string</value>\n      </attribute>\n   </attributes>\n</storage>\n",
      "storageDirectory": {
        "directoryPath": "string"
      },
      "storageFiles": [
        {
          "filePath": "string",
          "fileSizeBytes": 0,
          "rowCount": 0
        }
      ],
      "storageUnitStatus": "string"
    }
  ],
  "attributes": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "businessObjectDataParents": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0
    }
  ],
  "businessObjectDataChildren": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0
    }
  ],
  "businessObjectDataStatusHistory": [
    {
      "status": "string",
      "eventTime": "2017-04-29T14:40:26.563Z",
      "userId": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectData>
     <id>0</id>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <businessObjectFormatUsage>string</businessObjectFormatUsage>
     <businessObjectFormatFileType>string</businessObjectFormatFileType>
     <businessObjectFormatVersion>0</businessObjectFormatVersion>
     <partitionKey>string</partitionKey>
     <partitionValue>string</partitionValue>
     <subPartitionValues>
          <partitionValue>string</partitionValue>
     </subPartitionValues>
     <version>0</version>
     <latestVersion>true</latestVersion>
     <status>string</status>
     <storageUnits>
          <storageUnit>
               <storage>
                    <name>string</name>
                    <storagePlatformName>string</storagePlatformName>
                    <attributes>
                         <attribute>
                              <name>string</name>
                              <value>string</value>
                         </attribute>
                    </attributes>
               </storage>
               <storageDirectory>
                    <directoryPath>string</directoryPath>
               </storageDirectory>
               <storageFiles>
                    <storageFile>
                         <filePath>string</filePath>
                         <fileSizeBytes>0</fileSizeBytes>
                         <rowCount>0</rowCount>
                    </storageFile>
               </storageFiles>
               <storageUnitStatus>string</storageUnitStatus>
          </storageUnit>
     </storageUnits>
     <attributes>
          <attribute>
               <name>string</name>
               <value>string</value>
          </attribute>
     </attributes>
     <businessObjectDataParents>
          <businessObjectDataKey>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionValue>string</partitionValue>
               <subPartitionValues>
                    <partitionValue>string</partitionValue>
               </subPartitionValues>
               <businessObjectDataVersion>0</businessObjectDataVersion>
          </businessObjectDataKey>
     </businessObjectDataParents>
     <businessObjectDataChildren>
          <businessObjectDataKey>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionValue>string</partitionValue>
               <subPartitionValues>
                    <partitionValue>string</partitionValue>
               </subPartitionValues>
               <businessObjectDataVersion>0</businessObjectDataVersion>
          </businessObjectDataKey>
     </businessObjectDataChildren>
     <businessObjectDataStatusHistory>
          <businessObjectDataStatusChangeEvent>
               <status>string</status>
               <eventTime>2015-12-25T00:00:00.000-05:00</eventTime>
               <userId>string</userId>
          </businessObjectDataStatusChangeEvent>
     </businessObjectDataStatusHistory>
</businessObjectData>

Response Content Type

delete /businessObjectData/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/subPartition2Values/{subPartition2Value}/subPartition3Values/{subPartition3Value}/businessObjectDataVersions/{businessObjectDataVersion}

deleteBusinessObjectData

Implementation Notes

Deletes an existing business object data with 3 subpartition values with namespace

Requires WRITE permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace.	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
partitionValue	the partition value	path	string
subPartition1Value	sub-partition value 1	path	string
subPartition2Value	sub-partition value 2	path	string
subPartition3Value	sub-partition value 3	path	string
businessObjectDataVersion	the business object data version	path	integer
deleteFiles	whether files should be deleted	query	boolean

Response (Status 200)

businessObjectData {

id (integer, optional):

The internal Id that uniquely references the newly created Business Object Data

,

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionKey (string):

The Partition Key this Business Object Data is being registered with. This must be they Partition Key specified in the Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with this Business Object Data

,

version (integer, optional):

The numeric version of a Business Object Data. Each time a new data object is registered, the new version will be the previous version + 1

,

latestVersion (boolean, optional):

No longer in use A boolean flag that shows whether this instance of data is the latest or not. Once a new version of data is registered, any previous versions will no longer be the latest

,

status (string, optional):

The status of the Business Object Data. One of the following values: VALID, UPLOADING, PENDING_VALID, PROCESSING, INVALID, ARCHIVED, EXPIRED, or DELETED

,

storageUnits (Array[storageUnit], optional):

A container for the Storage Units associated with a Business Object Data

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage. Attributes values are required for certain keys that are defined as Attribute Definitions in the Business Object Format

,

businessObjectDataParents (Array[businessObjectDataKey], optional):

A list of Business Object Data parents (i.e. predecessors) that were used/needed in the creation of this data. This is used for data lineage. Each parent consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataChildren (Array[businessObjectDataKey], optional):

A list of Business Object Data children that were creation from this data. This is used for data lineage. Each child consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataStatusHistory (Array[businessObjectDataStatusChangeEvent], optional):

Lists all business object data status change events for this business object data

}
storageUnit {

storage (storage):

The Storage for this Storage Unit

,

storageDirectory (storageDirectory, optional):

A container for a Storage Directory that resides within a specific Storage Unit

,

storageFiles (Array[storageFile], optional):

A container of various Storage Files that reside within a specific Storage Unit

,

storageUnitStatus (string, optional):

The status of this Storage Unit. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}
businessObjectDataKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values this Business Object Data is associated with

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

}
businessObjectDataStatusChangeEvent {

status (string):

The status of the Business Object Data

,

eventTime (string):

The timestamp of when the business object data status change occurred

,

userId (string):

The User ID of the user who performed status update or registration of the Business Object Data

}
storage {

name (string):

Name of Storage

,

storagePlatformName (string):

Name of Storage Platform (eg S3) associated with this Storage

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage

}
storageDirectory {

directoryPath (string):

The fully qualified storage directory path

}
storageFile {

filePath (string):

The fully qualified file path to the data. When Storage Directory is specified, all Storage File paths should start with the Storage Directory path

,

fileSizeBytes (integer, optional):

The file size in bytes

,

rowCount (integer, optional):

The number of lines in the file

}

{
  "id": 0,
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "businessObjectFormatUsage": "string",
  "businessObjectFormatFileType": "string",
  "businessObjectFormatVersion": 0,
  "partitionKey": "string",
  "partitionValue": "string",
  "subPartitionValues": [
    "string"
  ],
  "version": 0,
  "latestVersion": true,
  "status": "string",
  "storageUnits": [
    {
      "storage": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<storage>\n   <name>string</name>\n   <storagePlatformName>string</storagePlatformName>\n   <attributes>\n      <attribute>\n         <name>string</name>\n         <value>string</value>\n      </attribute>\n   </attributes>\n</storage>\n",
      "storageDirectory": {
        "directoryPath": "string"
      },
      "storageFiles": [
        {
          "filePath": "string",
          "fileSizeBytes": 0,
          "rowCount": 0
        }
      ],
      "storageUnitStatus": "string"
    }
  ],
  "attributes": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "businessObjectDataParents": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0
    }
  ],
  "businessObjectDataChildren": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0
    }
  ],
  "businessObjectDataStatusHistory": [
    {
      "status": "string",
      "eventTime": "2017-04-29T14:40:26.573Z",
      "userId": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectData>
     <id>0</id>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <businessObjectFormatUsage>string</businessObjectFormatUsage>
     <businessObjectFormatFileType>string</businessObjectFormatFileType>
     <businessObjectFormatVersion>0</businessObjectFormatVersion>
     <partitionKey>string</partitionKey>
     <partitionValue>string</partitionValue>
     <subPartitionValues>
          <partitionValue>string</partitionValue>
     </subPartitionValues>
     <version>0</version>
     <latestVersion>true</latestVersion>
     <status>string</status>
     <storageUnits>
          <storageUnit>
               <storage>
                    <name>string</name>
                    <storagePlatformName>string</storagePlatformName>
                    <attributes>
                         <attribute>
                              <name>string</name>
                              <value>string</value>
                         </attribute>
                    </attributes>
               </storage>
               <storageDirectory>
                    <directoryPath>string</directoryPath>
               </storageDirectory>
               <storageFiles>
                    <storageFile>
                         <filePath>string</filePath>
                         <fileSizeBytes>0</fileSizeBytes>
                         <rowCount>0</rowCount>
                    </storageFile>
               </storageFiles>
               <storageUnitStatus>string</storageUnitStatus>
          </storageUnit>
     </storageUnits>
     <attributes>
          <attribute>
               <name>string</name>
               <value>string</value>
          </attribute>
     </attributes>
     <businessObjectDataParents>
          <businessObjectDataKey>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionValue>string</partitionValue>
               <subPartitionValues>
                    <partitionValue>string</partitionValue>
               </subPartitionValues>
               <businessObjectDataVersion>0</businessObjectDataVersion>
          </businessObjectDataKey>
     </businessObjectDataParents>
     <businessObjectDataChildren>
          <businessObjectDataKey>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionValue>string</partitionValue>
               <subPartitionValues>
                    <partitionValue>string</partitionValue>
               </subPartitionValues>
               <businessObjectDataVersion>0</businessObjectDataVersion>
          </businessObjectDataKey>
     </businessObjectDataChildren>
     <businessObjectDataStatusHistory>
          <businessObjectDataStatusChangeEvent>
               <status>string</status>
               <eventTime>2015-12-25T00:00:00.000-05:00</eventTime>
               <userId>string</userId>
          </businessObjectDataStatusChangeEvent>
     </businessObjectDataStatusHistory>
</businessObjectData>

Response Content Type

delete /businessObjectData/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/subPartition2Values/{subPartition2Value}/subPartition3Values/{subPartition3Value}/subPartition4Values/{subPartition4Value}/businessObjectDataVersions/{businessObjectDataVersion}

deleteBusinessObjectData

Implementation Notes

Deletes an existing business object data with 4 subpartition values with namespace.

Requires WRITE permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
partitionValue	the partition value	path	string
subPartition1Value	sub-partition value 1	path	string
subPartition2Value	sub-partition value 2	path	string
subPartition3Value	sub-partition value 3	path	string
subPartition4Value	sub-partition value 4	path	string
businessObjectDataVersion	the business object data version	path	integer
deleteFiles	whether files should be deleted	query	boolean

Response (Status 200)

businessObjectData {

id (integer, optional):

The internal Id that uniquely references the newly created Business Object Data

,

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionKey (string):

The Partition Key this Business Object Data is being registered with. This must be they Partition Key specified in the Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with this Business Object Data

,

version (integer, optional):

The numeric version of a Business Object Data. Each time a new data object is registered, the new version will be the previous version + 1

,

latestVersion (boolean, optional):

No longer in use A boolean flag that shows whether this instance of data is the latest or not. Once a new version of data is registered, any previous versions will no longer be the latest

,

status (string, optional):

The status of the Business Object Data. One of the following values: VALID, UPLOADING, PENDING_VALID, PROCESSING, INVALID, ARCHIVED, EXPIRED, or DELETED

,

storageUnits (Array[storageUnit], optional):

A container for the Storage Units associated with a Business Object Data

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage. Attributes values are required for certain keys that are defined as Attribute Definitions in the Business Object Format

,

businessObjectDataParents (Array[businessObjectDataKey], optional):

A list of Business Object Data parents (i.e. predecessors) that were used/needed in the creation of this data. This is used for data lineage. Each parent consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataChildren (Array[businessObjectDataKey], optional):

A list of Business Object Data children that were creation from this data. This is used for data lineage. Each child consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataStatusHistory (Array[businessObjectDataStatusChangeEvent], optional):

Lists all business object data status change events for this business object data

}
storageUnit {

storage (storage):

The Storage for this Storage Unit

,

storageDirectory (storageDirectory, optional):

A container for a Storage Directory that resides within a specific Storage Unit

,

storageFiles (Array[storageFile], optional):

A container of various Storage Files that reside within a specific Storage Unit

,

storageUnitStatus (string, optional):

The status of this Storage Unit. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}
businessObjectDataKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values this Business Object Data is associated with

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

}
businessObjectDataStatusChangeEvent {

status (string):

The status of the Business Object Data

,

eventTime (string):

The timestamp of when the business object data status change occurred

,

userId (string):

The User ID of the user who performed status update or registration of the Business Object Data

}
storage {

name (string):

Name of Storage

,

storagePlatformName (string):

Name of Storage Platform (eg S3) associated with this Storage

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage

}
storageDirectory {

directoryPath (string):

The fully qualified storage directory path

}
storageFile {

filePath (string):

The fully qualified file path to the data. When Storage Directory is specified, all Storage File paths should start with the Storage Directory path

,

fileSizeBytes (integer, optional):

The file size in bytes

,

rowCount (integer, optional):

The number of lines in the file

}

{
  "id": 0,
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "businessObjectFormatUsage": "string",
  "businessObjectFormatFileType": "string",
  "businessObjectFormatVersion": 0,
  "partitionKey": "string",
  "partitionValue": "string",
  "subPartitionValues": [
    "string"
  ],
  "version": 0,
  "latestVersion": true,
  "status": "string",
  "storageUnits": [
    {
      "storage": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<storage>\n   <name>string</name>\n   <storagePlatformName>string</storagePlatformName>\n   <attributes>\n      <attribute>\n         <name>string</name>\n         <value>string</value>\n      </attribute>\n   </attributes>\n</storage>\n",
      "storageDirectory": {
        "directoryPath": "string"
      },
      "storageFiles": [
        {
          "filePath": "string",
          "fileSizeBytes": 0,
          "rowCount": 0
        }
      ],
      "storageUnitStatus": "string"
    }
  ],
  "attributes": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "businessObjectDataParents": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0
    }
  ],
  "businessObjectDataChildren": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0
    }
  ],
  "businessObjectDataStatusHistory": [
    {
      "status": "string",
      "eventTime": "2017-04-29T14:40:26.581Z",
      "userId": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectData>
     <id>0</id>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <businessObjectFormatUsage>string</businessObjectFormatUsage>
     <businessObjectFormatFileType>string</businessObjectFormatFileType>
     <businessObjectFormatVersion>0</businessObjectFormatVersion>
     <partitionKey>string</partitionKey>
     <partitionValue>string</partitionValue>
     <subPartitionValues>
          <partitionValue>string</partitionValue>
     </subPartitionValues>
     <version>0</version>
     <latestVersion>true</latestVersion>
     <status>string</status>
     <storageUnits>
          <storageUnit>
               <storage>
                    <name>string</name>
                    <storagePlatformName>string</storagePlatformName>
                    <attributes>
                         <attribute>
                              <name>string</name>
                              <value>string</value>
                         </attribute>
                    </attributes>
               </storage>
               <storageDirectory>
                    <directoryPath>string</directoryPath>
               </storageDirectory>
               <storageFiles>
                    <storageFile>
                         <filePath>string</filePath>
                         <fileSizeBytes>0</fileSizeBytes>
                         <rowCount>0</rowCount>
                    </storageFile>
               </storageFiles>
               <storageUnitStatus>string</storageUnitStatus>
          </storageUnit>
     </storageUnits>
     <attributes>
          <attribute>
               <name>string</name>
               <value>string</value>
          </attribute>
     </attributes>
     <businessObjectDataParents>
          <businessObjectDataKey>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionValue>string</partitionValue>
               <subPartitionValues>
                    <partitionValue>string</partitionValue>
               </subPartitionValues>
               <businessObjectDataVersion>0</businessObjectDataVersion>
          </businessObjectDataKey>
     </businessObjectDataParents>
     <businessObjectDataChildren>
          <businessObjectDataKey>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionValue>string</partitionValue>
               <subPartitionValues>
                    <partitionValue>string</partitionValue>
               </subPartitionValues>
               <businessObjectDataVersion>0</businessObjectDataVersion>
          </businessObjectDataKey>
     </businessObjectDataChildren>
     <businessObjectDataStatusHistory>
          <businessObjectDataStatusChangeEvent>
               <status>string</status>
               <eventTime>2015-12-25T00:00:00.000-05:00</eventTime>
               <userId>string</userId>
          </businessObjectDataStatusChangeEvent>
     </businessObjectDataStatusHistory>
</businessObjectData>

Response Content Type

get /businessObjectData/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/s3KeyPrefix

Gets the S3 key prefix information for a specified namespace

Implementation Notes

Gets the S3 key prefix for writing or accessing business object data.

This endpoint requires a namespace.

Requires READ permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
partitionKey	the partition key	query	string
partitionValue	the partition value	query	string
subPartitionValues	the list of sub-partition values	query	string
businessObjectDataVersion	the business object data version	query	integer
storageName	the storage name	query	string
createNewVersion	Whether a new business object data can be created	query	boolean

Response (Status 200)

s3KeyPrefixInformation {

s3KeyPrefix (string):

The S3 key prefix to use when writing or accessing the data. Note that the S3 key prefix will not contain a trailing "directory" separator and it will be up to the caller to append one as needed

}

{
  "s3KeyPrefix": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<s3KeyPrefixInformation>
     <s3KeyPrefix>string</s3KeyPrefix>
</s3KeyPrefixInformation>

Response Content Type

get /businessObjectData/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/versions

getBusinessObjectDataVersions

Implementation Notes

Retrieves a list of existing business object data versions.

Requires READ permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
partitionValue	the partition value	query	string
subPartitionValues	the list of sub-partition values	query	string
businessObjectFormatVersion	the business object format version	query	integer
businessObjectDataVersion	the business object data version	query	integer

Response (Status 200)

businessObjectDataVersions {

businessObjectDataVersions (Array[businessObjectDataVersion], optional)

}
businessObjectDataVersion {

businessObjectDataKey (businessObjectDataKey):

Values that uniquely identify a Business Object Data

,

status (string):

The status of the Business Object Data

}
businessObjectDataKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values this Business Object Data is associated with

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

}

{
  "businessObjectDataVersions": [
    {
      "businessObjectDataKey": {
        "namespace": "string",
        "businessObjectDefinitionName": "string",
        "businessObjectFormatUsage": "string",
        "businessObjectFormatFileType": "string",
        "businessObjectFormatVersion": 0,
        "partitionValue": "string",
        "subPartitionValues": [
          "string"
        ],
        "businessObjectDataVersion": 0
      },
      "status": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataVersions>
     <businessObjectDataVersion>
          <businessObjectDataKey>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionValue>string</partitionValue>
               <subPartitionValues>
                    <partitionValue>string</partitionValue>
               </subPartitionValues>
               <businessObjectDataVersion>0</businessObjectDataVersion>
          </businessObjectDataKey>
          <status>string</status>
     </businessObjectDataVersion>
</businessObjectDataVersions>

Response Content Type

post /businessObjectData/restore/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/businessObjectDataVersions/{businessObjectDataVersion}

restoreBusinessObjectData

Implementation Notes

Initiates a restore request for a currently archived business object data.

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the version of the business object format	path	integer
partitionValue	the primary partition value of the business object data	path	string
businessObjectDataVersion	the version of the business object data	path	integer
subPartitionValues	the list of sub-partition values delimited by "\|" (delimiter can be escaped by "\")	query	string

Response (Status 200)

businessObjectData {

id (integer, optional):

The internal Id that uniquely references the newly created Business Object Data

,

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionKey (string):

The Partition Key this Business Object Data is being registered with. This must be they Partition Key specified in the Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with this Business Object Data

,

version (integer, optional):

The numeric version of a Business Object Data. Each time a new data object is registered, the new version will be the previous version + 1

,

latestVersion (boolean, optional):

No longer in use A boolean flag that shows whether this instance of data is the latest or not. Once a new version of data is registered, any previous versions will no longer be the latest

,

status (string, optional):

The status of the Business Object Data. One of the following values: VALID, UPLOADING, PENDING_VALID, PROCESSING, INVALID, ARCHIVED, EXPIRED, or DELETED

,

storageUnits (Array[storageUnit], optional):

A container for the Storage Units associated with a Business Object Data

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage. Attributes values are required for certain keys that are defined as Attribute Definitions in the Business Object Format

,

businessObjectDataParents (Array[businessObjectDataKey], optional):

A list of Business Object Data parents (i.e. predecessors) that were used/needed in the creation of this data. This is used for data lineage. Each parent consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataChildren (Array[businessObjectDataKey], optional):

A list of Business Object Data children that were creation from this data. This is used for data lineage. Each child consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataStatusHistory (Array[businessObjectDataStatusChangeEvent], optional):

Lists all business object data status change events for this business object data

}
storageUnit {

storage (storage):

The Storage for this Storage Unit

,

storageDirectory (storageDirectory, optional):

A container for a Storage Directory that resides within a specific Storage Unit

,

storageFiles (Array[storageFile], optional):

A container of various Storage Files that reside within a specific Storage Unit

,

storageUnitStatus (string, optional):

The status of this Storage Unit. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}
businessObjectDataKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values this Business Object Data is associated with

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

}
businessObjectDataStatusChangeEvent {

status (string):

The status of the Business Object Data

,

eventTime (string):

The timestamp of when the business object data status change occurred

,

userId (string):

The User ID of the user who performed status update or registration of the Business Object Data

}
storage {

name (string):

Name of Storage

,

storagePlatformName (string):

Name of Storage Platform (eg S3) associated with this Storage

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage

}
storageDirectory {

directoryPath (string):

The fully qualified storage directory path

}
storageFile {

filePath (string):

The fully qualified file path to the data. When Storage Directory is specified, all Storage File paths should start with the Storage Directory path

,

fileSizeBytes (integer, optional):

The file size in bytes

,

rowCount (integer, optional):

The number of lines in the file

}

{
  "id": 0,
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "businessObjectFormatUsage": "string",
  "businessObjectFormatFileType": "string",
  "businessObjectFormatVersion": 0,
  "partitionKey": "string",
  "partitionValue": "string",
  "subPartitionValues": [
    "string"
  ],
  "version": 0,
  "latestVersion": true,
  "status": "string",
  "storageUnits": [
    {
      "storage": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<storage>\n   <name>string</name>\n   <storagePlatformName>string</storagePlatformName>\n   <attributes>\n      <attribute>\n         <name>string</name>\n         <value>string</value>\n      </attribute>\n   </attributes>\n</storage>\n",
      "storageDirectory": {
        "directoryPath": "string"
      },
      "storageFiles": [
        {
          "filePath": "string",
          "fileSizeBytes": 0,
          "rowCount": 0
        }
      ],
      "storageUnitStatus": "string"
    }
  ],
  "attributes": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "businessObjectDataParents": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0
    }
  ],
  "businessObjectDataChildren": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0
    }
  ],
  "businessObjectDataStatusHistory": [
    {
      "status": "string",
      "eventTime": "2017-04-29T14:40:26.602Z",
      "userId": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectData>
     <id>0</id>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <businessObjectFormatUsage>string</businessObjectFormatUsage>
     <businessObjectFormatFileType>string</businessObjectFormatFileType>
     <businessObjectFormatVersion>0</businessObjectFormatVersion>
     <partitionKey>string</partitionKey>
     <partitionValue>string</partitionValue>
     <subPartitionValues>
          <partitionValue>string</partitionValue>
     </subPartitionValues>
     <version>0</version>
     <latestVersion>true</latestVersion>
     <status>string</status>
     <storageUnits>
          <storageUnit>
               <storage>
                    <name>string</name>
                    <storagePlatformName>string</storagePlatformName>
                    <attributes>
                         <attribute>
                              <name>string</name>
                              <value>string</value>
                         </attribute>
                    </attributes>
               </storage>
               <storageDirectory>
                    <directoryPath>string</directoryPath>
               </storageDirectory>
               <storageFiles>
                    <storageFile>
                         <filePath>string</filePath>
                         <fileSizeBytes>0</fileSizeBytes>
                         <rowCount>0</rowCount>
                    </storageFile>
               </storageFiles>
               <storageUnitStatus>string</storageUnitStatus>
          </storageUnit>
     </storageUnits>
     <attributes>
          <attribute>
               <name>string</name>
               <value>string</value>
          </attribute>
     </attributes>
     <businessObjectDataParents>
          <businessObjectDataKey>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionValue>string</partitionValue>
               <subPartitionValues>
                    <partitionValue>string</partitionValue>
               </subPartitionValues>
               <businessObjectDataVersion>0</businessObjectDataVersion>
          </businessObjectDataKey>
     </businessObjectDataParents>
     <businessObjectDataChildren>
          <businessObjectDataKey>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionValue>string</partitionValue>
               <subPartitionValues>
                    <partitionValue>string</partitionValue>
               </subPartitionValues>
               <businessObjectDataVersion>0</businessObjectDataVersion>
          </businessObjectDataKey>
     </businessObjectDataChildren>
     <businessObjectDataStatusHistory>
          <businessObjectDataStatusChangeEvent>
               <status>string</status>
               <eventTime>2015-12-25T00:00:00.000-05:00</eventTime>
               <userId>string</userId>
          </businessObjectDataStatusChangeEvent>
     </businessObjectDataStatusHistory>
</businessObjectData>

Response Content Type

post /businessObjectData/retryStoragePolicyTransition/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/businessObjectDataVersions/{businessObjectDataVersion}

retryStoragePolicyTransition

Implementation Notes

Retries a storage policy transition by forcing re-initiation of the archiving process for the specified business object data that is still in progress of a valid archiving operation. This endpoint is designed to be run only after confirmation that the business object data is stuck due to an error during archiving.

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace of the business object definition	path	string
businessObjectDefinitionName		the name of the business object definition	path	string
businessObjectFormatUsage		the usage of the business object format	path	string
businessObjectFormatFileType		the file type of the business object format	path	string
businessObjectFormatVersion		the version of the business object format	path	integer
partitionValue		the primary partition value of the business object data	path	string
businessObjectDataVersion		the version of the business object data	path	integer
subPartitionValues		the optional list of sub-partition values delimited by "\|" (delimiter can be escaped by "\")	query	string
businessObjectDataRetryStoragePolicyTransitionRequest: the information needed to retry a storage policy transition	Parameter content type: Model JSON Schema XML Example businessObjectDataRetryStoragePolicyTransitionRequest { storagePolicyKey (storagePolicyKey): Wrapper for the storage policy unique identifiers } storagePolicyKey { namespace (string): The namespace of the storage policy , storagePolicyName (string): The name of the storage policy } `{ "storagePolicyKey": { "namespace": "string", "storagePolicyName": "string" } }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <businessObjectDataRetryStoragePolicyTransitionRequest> <storagePolicyKey> <namespace>string</namespace> <storagePolicyName>string</storagePolicyName> </storagePolicyKey> </businessObjectDataRetryStoragePolicyTransitionRequest>` Click to set as parameter value

Response (Status 200)

businessObjectData {

id (integer, optional):

The internal Id that uniquely references the newly created Business Object Data

,

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionKey (string):

The Partition Key this Business Object Data is being registered with. This must be they Partition Key specified in the Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with this Business Object Data

,

version (integer, optional):

The numeric version of a Business Object Data. Each time a new data object is registered, the new version will be the previous version + 1

,

latestVersion (boolean, optional):

No longer in use A boolean flag that shows whether this instance of data is the latest or not. Once a new version of data is registered, any previous versions will no longer be the latest

,

status (string, optional):

The status of the Business Object Data. One of the following values: VALID, UPLOADING, PENDING_VALID, PROCESSING, INVALID, ARCHIVED, EXPIRED, or DELETED

,

storageUnits (Array[storageUnit], optional):

A container for the Storage Units associated with a Business Object Data

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage. Attributes values are required for certain keys that are defined as Attribute Definitions in the Business Object Format

,

businessObjectDataParents (Array[businessObjectDataKey], optional):

A list of Business Object Data parents (i.e. predecessors) that were used/needed in the creation of this data. This is used for data lineage. Each parent consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataChildren (Array[businessObjectDataKey], optional):

A list of Business Object Data children that were creation from this data. This is used for data lineage. Each child consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataStatusHistory (Array[businessObjectDataStatusChangeEvent], optional):

Lists all business object data status change events for this business object data

}
storageUnit {

storage (storage):

The Storage for this Storage Unit

,

storageDirectory (storageDirectory, optional):

A container for a Storage Directory that resides within a specific Storage Unit

,

storageFiles (Array[storageFile], optional):

A container of various Storage Files that reside within a specific Storage Unit

,

storageUnitStatus (string, optional):

The status of this Storage Unit. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}
businessObjectDataKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values this Business Object Data is associated with

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

}
businessObjectDataStatusChangeEvent {

status (string):

The status of the Business Object Data

,

eventTime (string):

The timestamp of when the business object data status change occurred

,

userId (string):

The User ID of the user who performed status update or registration of the Business Object Data

}
storage {

name (string):

Name of Storage

,

storagePlatformName (string):

Name of Storage Platform (eg S3) associated with this Storage

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage

}
storageDirectory {

directoryPath (string):

The fully qualified storage directory path

}
storageFile {

filePath (string):

The fully qualified file path to the data. When Storage Directory is specified, all Storage File paths should start with the Storage Directory path

,

fileSizeBytes (integer, optional):

The file size in bytes

,

rowCount (integer, optional):

The number of lines in the file

}

{
  "id": 0,
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "businessObjectFormatUsage": "string",
  "businessObjectFormatFileType": "string",
  "businessObjectFormatVersion": 0,
  "partitionKey": "string",
  "partitionValue": "string",
  "subPartitionValues": [
    "string"
  ],
  "version": 0,
  "latestVersion": true,
  "status": "string",
  "storageUnits": [
    {
      "storage": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<storage>\n   <name>string</name>\n   <storagePlatformName>string</storagePlatformName>\n   <attributes>\n      <attribute>\n         <name>string</name>\n         <value>string</value>\n      </attribute>\n   </attributes>\n</storage>\n",
      "storageDirectory": {
        "directoryPath": "string"
      },
      "storageFiles": [
        {
          "filePath": "string",
          "fileSizeBytes": 0,
          "rowCount": 0
        }
      ],
      "storageUnitStatus": "string"
    }
  ],
  "attributes": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "businessObjectDataParents": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0
    }
  ],
  "businessObjectDataChildren": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0
    }
  ],
  "businessObjectDataStatusHistory": [
    {
      "status": "string",
      "eventTime": "2017-04-29T14:40:26.610Z",
      "userId": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectData>
     <id>0</id>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <businessObjectFormatUsage>string</businessObjectFormatUsage>
     <businessObjectFormatFileType>string</businessObjectFormatFileType>
     <businessObjectFormatVersion>0</businessObjectFormatVersion>
     <partitionKey>string</partitionKey>
     <partitionValue>string</partitionValue>
     <subPartitionValues>
          <partitionValue>string</partitionValue>
     </subPartitionValues>
     <version>0</version>
     <latestVersion>true</latestVersion>
     <status>string</status>
     <storageUnits>
          <storageUnit>
               <storage>
                    <name>string</name>
                    <storagePlatformName>string</storagePlatformName>
                    <attributes>
                         <attribute>
                              <name>string</name>
                              <value>string</value>
                         </attribute>
                    </attributes>
               </storage>
               <storageDirectory>
                    <directoryPath>string</directoryPath>
               </storageDirectory>
               <storageFiles>
                    <storageFile>
                         <filePath>string</filePath>
                         <fileSizeBytes>0</fileSizeBytes>
                         <rowCount>0</rowCount>
                    </storageFile>
               </storageFiles>
               <storageUnitStatus>string</storageUnitStatus>
          </storageUnit>
     </storageUnits>
     <attributes>
          <attribute>
               <name>string</name>
               <value>string</value>
          </attribute>
     </attributes>
     <businessObjectDataParents>
          <businessObjectDataKey>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionValue>string</partitionValue>
               <subPartitionValues>
                    <partitionValue>string</partitionValue>
               </subPartitionValues>
               <businessObjectDataVersion>0</businessObjectDataVersion>
          </businessObjectDataKey>
     </businessObjectDataParents>
     <businessObjectDataChildren>
          <businessObjectDataKey>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionValue>string</partitionValue>
               <subPartitionValues>
                    <partitionValue>string</partitionValue>
               </subPartitionValues>
               <businessObjectDataVersion>0</businessObjectDataVersion>
          </businessObjectDataKey>
     </businessObjectDataChildren>
     <businessObjectDataStatusHistory>
          <businessObjectDataStatusChangeEvent>
               <status>string</status>
               <eventTime>2015-12-25T00:00:00.000-05:00</eventTime>
               <userId>string</userId>
          </businessObjectDataStatusChangeEvent>
     </businessObjectDataStatusHistory>
</businessObjectData>

Response Content Type

post /businessObjectData/search

searchBusinessObjectData

Implementation Notes

Searches business object data based on namespace, definition name, format usage, file type, and format version.

Namespace and definition name are required.

Requires READ permission on namespace

Parameter (body): search request
Parameter content type: Model JSON Schema XML Example businessObjectDataSearchRequest { businessObjectDataSearchFilters (Array[businessObjectDataSearchFilter], optional) } businessObjectDataSearchFilter { businessObjectDataSearchKeys (Array[businessObjectDataSearchKey], optional): Values that identify a Business Object Search Keys } businessObjectDataSearchKey { namespace (string, optional): The Namespace to which a Business Object Format is related , businessObjectDefinitionName (string, optional): The name of the Business Object Definition to which a Business Object Format is related , businessObjectFormatUsage (string, optional): The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions , businessObjectFormatFileType (string, optional): A File Type known to the system that describes the file type of data stored under a Business Object Format , businessObjectFormatVersion (integer, optional): The numeric version of a Business Object Format. Each time a format is registered, the new version will be the previous version `+ 1` , partitionValueFilters (Array[partitionValueFilter], optional): A container for Partition Value Filters } partitionValueFilter { partitionKey (string, optional): The Partition Key for a Business Object Data. This must be they Partition Key specified in the Business Object Format. Required when partitionValueFilters is present , partitionValues (Array[string], optional): This specifies a list of partition values. Required when partitionValueRange, latestBeforePartitionValue, or latestAfterPartitionValue is not present , partitionValueRange (partitionValueRange, optional): A container for the Partition Value Range. A Partition Key Group value is required in the Business Object Format in order to use a Partition Value Range when requesting to check the Business Object Data availability. The Partition Key Group value will be used to identify the ordered set of Expected Partition Values. For more information please see *LINK Business Object Format Post and* LINK Expected Partition Values Post. Only a single Partition Value Range is allowed per request. This value is required only when partitionValues, latestBeforePartitionValue, or latestAfterPartitionValue is not present , latestBeforePartitionValue (latestBeforePartitionValue, optional): This specifies that the availability request should return the latest Partition Value available before the specified Partition Value. If there is no available partition before the specified value, the response will not include any partitions. When Business Object Data Version is not specified, the Latest Before Partition Value for "VALID" business object data is returned back. This value is only required when partitionValues, partitionValueRange, or latestAfterPartitionValue is not present , latestAfterPartitionValue (latestAfterPartitionValue, optional): This specifies that the availability request should return the latest Partition Value available after the specified Partition Value. If there is no available partition after the specified value, the response will not include any partitions. When Business Object Data Version is not specified, the Latest Before Partition Value for "VALID" business object data is returned back. This value is only required when partitionValues, partitionValueRange, or latestAfterPartitionValue is not present } partitionValueRange { startPartitionValue (string): The start partition value for the partition value range. Required when partitionValueRange is present , endPartitionValue (string): The end partition value for the partition value range. Required when partitionValueRange is present } latestBeforePartitionValue { partitionValue (string): The partition value that is an inclusive upper bound for the latest available partition value. Required when latestBeforePartitionValue is present } latestAfterPartitionValue { partitionValue (string): The partition value that is an inclusive lower bound for the latest available partition value. Required when latestAfterPartitionValue is present } { "businessObjectDataSearchFilters": [ { "businessObjectDataSearchKeys": [ { "namespace": "string", "businessObjectDefinitionName": "string", "businessObjectFormatUsage": "string", "businessObjectFormatFileType": "string", "businessObjectFormatVersion": 0, "partitionValueFilters": [ { "partitionKey": "string", "partitionValues": [ "string" ], "partitionValueRange": { "startPartitionValue": "string", "endPartitionValue": "string" }, "latestBeforePartitionValue": { "partitionValue": "string" }, "latestAfterPartitionValue": { "partitionValue": "string" } } ] } ] } ] } Click to set as parameter value <?xml version="1.0" encoding="UTF-8"?> <businessObjectDataSearchRequest> <businessObjectDataSearchFilters> <businessObjectDataSearchFilter> <businessObjectDataSearchKeys> <businessObjectDataSearchKey> <namespace>string</namespace> <businessObjectDefinitionName>string</businessObjectDefinitionName> <businessObjectFormatUsage>string</businessObjectFormatUsage> <businessObjectFormatFileType>string</businessObjectFormatFileType> <businessObjectFormatVersion>0</businessObjectFormatVersion> <partitionValueFilters> <partitionValueFilter> <partitionKey>string</partitionKey> <partitionValues> <partitionValue>string</partitionValue> </partitionValues> <partitionValueRange> <startPartitionValue>string</startPartitionValue> <endPartitionValue>string</endPartitionValue> </partitionValueRange> <latestBeforePartitionValue> <partitionValue>string</partitionValue> </latestBeforePartitionValue> <latestAfterPartitionValue> <partitionValue>string</partitionValue> </latestAfterPartitionValue> </partitionValueFilter> </partitionValueFilters> </businessObjectDataSearchKey> </businessObjectDataSearchKeys> </businessObjectDataSearchFilter> </businessObjectDataSearchFilters> </businessObjectDataSearchRequest> Click to set as parameter value

Response (Status 200)

businessObjectDataSearchResult {

businessObjectDataElements (Array[businessObjectData], optional)

}
businessObjectData {

id (integer, optional):

The internal Id that uniquely references the newly created Business Object Data

,

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionKey (string):

The Partition Key this Business Object Data is being registered with. This must be they Partition Key specified in the Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with this Business Object Data

,

version (integer, optional):

The numeric version of a Business Object Data. Each time a new data object is registered, the new version will be the previous version + 1

,

latestVersion (boolean, optional):

No longer in use A boolean flag that shows whether this instance of data is the latest or not. Once a new version of data is registered, any previous versions will no longer be the latest

,

status (string, optional):

The status of the Business Object Data. One of the following values: VALID, UPLOADING, PENDING_VALID, PROCESSING, INVALID, ARCHIVED, EXPIRED, or DELETED

,

storageUnits (Array[storageUnit], optional):

A container for the Storage Units associated with a Business Object Data

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage. Attributes values are required for certain keys that are defined as Attribute Definitions in the Business Object Format

,

businessObjectDataParents (Array[businessObjectDataKey], optional):

A list of Business Object Data parents (i.e. predecessors) that were used/needed in the creation of this data. This is used for data lineage. Each parent consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataChildren (Array[businessObjectDataKey], optional):

A list of Business Object Data children that were creation from this data. This is used for data lineage. Each child consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataStatusHistory (Array[businessObjectDataStatusChangeEvent], optional):

Lists all business object data status change events for this business object data

}
storageUnit {

storage (storage):

The Storage for this Storage Unit

,

storageDirectory (storageDirectory, optional):

A container for a Storage Directory that resides within a specific Storage Unit

,

storageFiles (Array[storageFile], optional):

A container of various Storage Files that reside within a specific Storage Unit

,

storageUnitStatus (string, optional):

The status of this Storage Unit. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}
businessObjectDataKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values this Business Object Data is associated with

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

}
businessObjectDataStatusChangeEvent {

status (string):

The status of the Business Object Data

,

eventTime (string):

The timestamp of when the business object data status change occurred

,

userId (string):

The User ID of the user who performed status update or registration of the Business Object Data

}
storage {

name (string):

Name of Storage

,

storagePlatformName (string):

Name of Storage Platform (eg S3) associated with this Storage

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage

}
storageDirectory {

directoryPath (string):

The fully qualified storage directory path

}
storageFile {

filePath (string):

The fully qualified file path to the data. When Storage Directory is specified, all Storage File paths should start with the Storage Directory path

,

fileSizeBytes (integer, optional):

The file size in bytes

,

rowCount (integer, optional):

The number of lines in the file

}

{
  "businessObjectDataElements": [
    "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<businessObjectData>\n   <id>0</id>\n   <namespace>string</namespace>\n   <businessObjectDefinitionName>string</businessObjectDefinitionName>\n   <businessObjectFormatUsage>string</businessObjectFormatUsage>\n   <businessObjectFormatFileType>string</businessObjectFormatFileType>\n   <businessObjectFormatVersion>0</businessObjectFormatVersion>\n   <partitionKey>string</partitionKey>\n   <partitionValue>string</partitionValue>\n   <subPartitionValues>\n      <partitionValue>string</partitionValue>\n   </subPartitionValues>\n   <version>0</version>\n   <latestVersion>true</latestVersion>\n   <status>string</status>\n   <storageUnits>\n      <storageUnit>\n         <storage>\n            <name>string</name>\n            <storagePlatformName>string</storagePlatformName>\n            <attributes>\n               <attribute>\n                  <name>string</name>\n                  <value>string</value>\n               </attribute>\n            </attributes>\n         </storage>\n         <storageDirectory>\n            <directoryPath>string</directoryPath>\n         </storageDirectory>\n         <storageFiles>\n            <storageFile>\n               <filePath>string</filePath>\n               <fileSizeBytes>0</fileSizeBytes>\n               <rowCount>0</rowCount>\n            </storageFile>\n         </storageFiles>\n         <storageUnitStatus>string</storageUnitStatus>\n      </storageUnit>\n   </storageUnits>\n   <attributes>\n      <attribute>\n         <name>string</name>\n         <value>string</value>\n      </attribute>\n   </attributes>\n   <businessObjectDataParents>\n      <businessObjectDataKey>\n         <namespace>string</namespace>\n         <businessObjectDefinitionName>string</businessObjectDefinitionName>\n         <businessObjectFormatUsage>string</businessObjectFormatUsage>\n         <businessObjectFormatFileType>string</businessObjectFormatFileType>\n         <businessObjectFormatVersion>0</businessObjectFormatVersion>\n         <partitionValue>string</partitionValue>\n         <subPartitionValues>\n            <partitionValue>string</partitionValue>\n         </subPartitionValues>\n         <businessObjectDataVersion>0</businessObjectDataVersion>\n      </businessObjectDataKey>\n   </businessObjectDataParents>\n   <businessObjectDataChildren>\n      <businessObjectDataKey>\n         <namespace>string</namespace>\n         <businessObjectDefinitionName>string</businessObjectDefinitionName>\n         <businessObjectFormatUsage>string</businessObjectFormatUsage>\n         <businessObjectFormatFileType>string</businessObjectFormatFileType>\n         <businessObjectFormatVersion>0</businessObjectFormatVersion>\n         <partitionValue>string</partitionValue>\n         <subPartitionValues>\n            <partitionValue>string</partitionValue>\n         </subPartitionValues>\n         <businessObjectDataVersion>0</businessObjectDataVersion>\n      </businessObjectDataKey>\n   </businessObjectDataChildren>\n   <businessObjectDataStatusHistory>\n      <businessObjectDataStatusChangeEvent>\n         <status>string</status>\n         <eventTime>2015-12-25T00:00:00.000-05:00</eventTime>\n         <userId>string</userId>\n      </businessObjectDataStatusChangeEvent>\n   </businessObjectDataStatusHistory>\n</businessObjectData>\n"
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataSearchResult>
     <businessObjectDataElements>
          <businessObjectData>
               <id>0</id>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionKey>string</partitionKey>
               <partitionValue>string</partitionValue>
               <subPartitionValues>
                    <partitionValue>string</partitionValue>
               </subPartitionValues>
               <version>0</version>
               <latestVersion>true</latestVersion>
               <status>string</status>
               <storageUnits>
                    <storageUnit>
                         <storage>
                              <name>string</name>
                              <storagePlatformName>string</storagePlatformName>
                              <attributes>
                                   <attribute>
                                        <name>string</name>
                                        <value>string</value>
                                   </attribute>
                              </attributes>
                         </storage>
                         <storageDirectory>
                              <directoryPath>string</directoryPath>
                         </storageDirectory>
                         <storageFiles>
                              <storageFile>
                                   <filePath>string</filePath>
                                   <fileSizeBytes>0</fileSizeBytes>
                                   <rowCount>0</rowCount>
                              </storageFile>
                         </storageFiles>
                         <storageUnitStatus>string</storageUnitStatus>
                    </storageUnit>
               </storageUnits>
               <attributes>
                    <attribute>
                         <name>string</name>
                         <value>string</value>
                    </attribute>
               </attributes>
               <businessObjectDataParents>
                    <businessObjectDataKey>
                         <namespace>string</namespace>
                         <businessObjectDefinitionName>string</businessObjectDefinitionName>
                         <businessObjectFormatUsage>string</businessObjectFormatUsage>
                         <businessObjectFormatFileType>string</businessObjectFormatFileType>
                         <businessObjectFormatVersion>0</businessObjectFormatVersion>
                         <partitionValue>string</partitionValue>
                         <subPartitionValues>
                              <partitionValue>string</partitionValue>
                         </subPartitionValues>
                         <businessObjectDataVersion>0</businessObjectDataVersion>
                    </businessObjectDataKey>
               </businessObjectDataParents>
               <businessObjectDataChildren>
                    <businessObjectDataKey>
                         <namespace>string</namespace>
                         <businessObjectDefinitionName>string</businessObjectDefinitionName>
                         <businessObjectFormatUsage>string</businessObjectFormatUsage>
                         <businessObjectFormatFileType>string</businessObjectFormatFileType>
                         <businessObjectFormatVersion>0</businessObjectFormatVersion>
                         <partitionValue>string</partitionValue>
                         <subPartitionValues>
                              <partitionValue>string</partitionValue>
                         </subPartitionValues>
                         <businessObjectDataVersion>0</businessObjectDataVersion>
                    </businessObjectDataKey>
               </businessObjectDataChildren>
               <businessObjectDataStatusHistory>
                    <businessObjectDataStatusChangeEvent>
                         <status>string</status>
                         <eventTime>2015-12-25T00:00:00.000-05:00</eventTime>
                         <userId>string</userId>
                    </businessObjectDataStatusChangeEvent>
               </businessObjectDataStatusHistory>
          </businessObjectData>
     </businessObjectDataElements>
</businessObjectDataSearchResult>

Response Content Type

post /businessObjectData/unregistered/invalidation

invalidateUnregisteredBusinessObjectData

Implementation Notes

Registers data as INVALID for objects which exist in S3 but are not registered in herd.

Requires WRITE permission on namespace

Parameter (body): the business object data invalidate un-register request
Parameter content type: Model JSON Schema XML Example businessObjectDataInvalidateUnregisteredRequest { namespace (string), businessObjectDefinitionName (string), businessObjectFormatUsage (string), businessObjectFormatFileType (string), businessObjectFormatVersion (integer, optional), partitionValue (string), subPartitionValues (Array[string], optional), storageName (string) } `{ "namespace": "string", "businessObjectDefinitionName": "string", "businessObjectFormatUsage": "string", "businessObjectFormatFileType": "string", "businessObjectFormatVersion": 0, "partitionValue": "string", "subPartitionValues": [ "string" ], "storageName": "string" }` Click to set as parameter value <?xml version="1.0" encoding="UTF-8"?> <businessObjectDataInvalidateUnregisteredRequest> <namespace>string</namespace> <businessObjectDefinitionName>string</businessObjectDefinitionName> <businessObjectFormatUsage>string</businessObjectFormatUsage> <businessObjectFormatFileType>string</businessObjectFormatFileType> <businessObjectFormatVersion>0</businessObjectFormatVersion> <partitionValue>string</partitionValue> <subPartitionValues> <partitionValue>string</partitionValue> </subPartitionValues> <storageName>string</storageName> </businessObjectDataInvalidateUnregisteredRequest> Click to set as parameter value

Parameter (body): the business object data invalidate un-register request

Parameter content type:

businessObjectDataInvalidateUnregisteredRequest {

namespace (string),

businessObjectDefinitionName (string),

businessObjectFormatUsage (string),

businessObjectFormatFileType (string),

businessObjectFormatVersion (integer, optional),

partitionValue (string),

subPartitionValues (Array[string], optional),

storageName (string)

}

{
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "businessObjectFormatUsage": "string",
  "businessObjectFormatFileType": "string",
  "businessObjectFormatVersion": 0,
  "partitionValue": "string",
  "subPartitionValues": [
    "string"
  ],
  "storageName": "string"
}

Click to set as parameter value

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataInvalidateUnregisteredRequest>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <businessObjectFormatUsage>string</businessObjectFormatUsage>
     <businessObjectFormatFileType>string</businessObjectFormatFileType>
     <businessObjectFormatVersion>0</businessObjectFormatVersion>
     <partitionValue>string</partitionValue>
     <subPartitionValues>
          <partitionValue>string</partitionValue>
     </subPartitionValues>
     <storageName>string</storageName>
</businessObjectDataInvalidateUnregisteredRequest>

Click to set as parameter value

Response (Status 200)

businessObjectDataInvalidateUnregisteredResponse {

namespace (string),

businessObjectDefinitionName (string),

businessObjectFormatUsage (string),

businessObjectFormatFileType (string),

businessObjectFormatVersion (integer, optional),

partitionValue (string),

subPartitionValues (Array[string], optional),

storageName (string),

registeredBusinessObjectDataList (Array[businessObjectData], optional)

}
businessObjectData {

id (integer, optional):

The internal Id that uniquely references the newly created Business Object Data

,

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionKey (string):

The Partition Key this Business Object Data is being registered with. This must be they Partition Key specified in the Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with this Business Object Data

,

version (integer, optional):

The numeric version of a Business Object Data. Each time a new data object is registered, the new version will be the previous version + 1

,

latestVersion (boolean, optional):

No longer in use A boolean flag that shows whether this instance of data is the latest or not. Once a new version of data is registered, any previous versions will no longer be the latest

,

status (string, optional):

The status of the Business Object Data. One of the following values: VALID, UPLOADING, PENDING_VALID, PROCESSING, INVALID, ARCHIVED, EXPIRED, or DELETED

,

storageUnits (Array[storageUnit], optional):

A container for the Storage Units associated with a Business Object Data

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage. Attributes values are required for certain keys that are defined as Attribute Definitions in the Business Object Format

,

businessObjectDataParents (Array[businessObjectDataKey], optional):

A list of Business Object Data parents (i.e. predecessors) that were used/needed in the creation of this data. This is used for data lineage. Each parent consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataChildren (Array[businessObjectDataKey], optional):

A list of Business Object Data children that were creation from this data. This is used for data lineage. Each child consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataStatusHistory (Array[businessObjectDataStatusChangeEvent], optional):

Lists all business object data status change events for this business object data

}
storageUnit {

storage (storage):

The Storage for this Storage Unit

,

storageDirectory (storageDirectory, optional):

A container for a Storage Directory that resides within a specific Storage Unit

,

storageFiles (Array[storageFile], optional):

A container of various Storage Files that reside within a specific Storage Unit

,

storageUnitStatus (string, optional):

The status of this Storage Unit. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}
businessObjectDataKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values this Business Object Data is associated with

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

}
businessObjectDataStatusChangeEvent {

status (string):

The status of the Business Object Data

,

eventTime (string):

The timestamp of when the business object data status change occurred

,

userId (string):

The User ID of the user who performed status update or registration of the Business Object Data

}
storage {

name (string):

Name of Storage

,

storagePlatformName (string):

Name of Storage Platform (eg S3) associated with this Storage

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage

}
storageDirectory {

directoryPath (string):

The fully qualified storage directory path

}
storageFile {

filePath (string):

The fully qualified file path to the data. When Storage Directory is specified, all Storage File paths should start with the Storage Directory path

,

fileSizeBytes (integer, optional):

The file size in bytes

,

rowCount (integer, optional):

The number of lines in the file

}

{
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "businessObjectFormatUsage": "string",
  "businessObjectFormatFileType": "string",
  "businessObjectFormatVersion": 0,
  "partitionValue": "string",
  "subPartitionValues": [
    "string"
  ],
  "storageName": "string",
  "registeredBusinessObjectDataList": [
    "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<businessObjectData>\n   <id>0</id>\n   <namespace>string</namespace>\n   <businessObjectDefinitionName>string</businessObjectDefinitionName>\n   <businessObjectFormatUsage>string</businessObjectFormatUsage>\n   <businessObjectFormatFileType>string</businessObjectFormatFileType>\n   <businessObjectFormatVersion>0</businessObjectFormatVersion>\n   <partitionKey>string</partitionKey>\n   <partitionValue>string</partitionValue>\n   <subPartitionValues>\n      <partitionValue>string</partitionValue>\n   </subPartitionValues>\n   <version>0</version>\n   <latestVersion>true</latestVersion>\n   <status>string</status>\n   <storageUnits>\n      <storageUnit>\n         <storage>\n            <name>string</name>\n            <storagePlatformName>string</storagePlatformName>\n            <attributes>\n               <attribute>\n                  <name>string</name>\n                  <value>string</value>\n               </attribute>\n            </attributes>\n         </storage>\n         <storageDirectory>\n            <directoryPath>string</directoryPath>\n         </storageDirectory>\n         <storageFiles>\n            <storageFile>\n               <filePath>string</filePath>\n               <fileSizeBytes>0</fileSizeBytes>\n               <rowCount>0</rowCount>\n            </storageFile>\n         </storageFiles>\n         <storageUnitStatus>string</storageUnitStatus>\n      </storageUnit>\n   </storageUnits>\n   <attributes>\n      <attribute>\n         <name>string</name>\n         <value>string</value>\n      </attribute>\n   </attributes>\n   <businessObjectDataParents>\n      <businessObjectDataKey>\n         <namespace>string</namespace>\n         <businessObjectDefinitionName>string</businessObjectDefinitionName>\n         <businessObjectFormatUsage>string</businessObjectFormatUsage>\n         <businessObjectFormatFileType>string</businessObjectFormatFileType>\n         <businessObjectFormatVersion>0</businessObjectFormatVersion>\n         <partitionValue>string</partitionValue>\n         <subPartitionValues>\n            <partitionValue>string</partitionValue>\n         </subPartitionValues>\n         <businessObjectDataVersion>0</businessObjectDataVersion>\n      </businessObjectDataKey>\n   </businessObjectDataParents>\n   <businessObjectDataChildren>\n      <businessObjectDataKey>\n         <namespace>string</namespace>\n         <businessObjectDefinitionName>string</businessObjectDefinitionName>\n         <businessObjectFormatUsage>string</businessObjectFormatUsage>\n         <businessObjectFormatFileType>string</businessObjectFormatFileType>\n         <businessObjectFormatVersion>0</businessObjectFormatVersion>\n         <partitionValue>string</partitionValue>\n         <subPartitionValues>\n            <partitionValue>string</partitionValue>\n         </subPartitionValues>\n         <businessObjectDataVersion>0</businessObjectDataVersion>\n      </businessObjectDataKey>\n   </businessObjectDataChildren>\n   <businessObjectDataStatusHistory>\n      <businessObjectDataStatusChangeEvent>\n         <status>string</status>\n         <eventTime>2015-12-25T00:00:00.000-05:00</eventTime>\n         <userId>string</userId>\n      </businessObjectDataStatusChangeEvent>\n   </businessObjectDataStatusHistory>\n</businessObjectData>\n"
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataInvalidateUnregisteredResponse>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <businessObjectFormatUsage>string</businessObjectFormatUsage>
     <businessObjectFormatFileType>string</businessObjectFormatFileType>
     <businessObjectFormatVersion>0</businessObjectFormatVersion>
     <partitionValue>string</partitionValue>
     <subPartitionValues>
          <partitionValue>string</partitionValue>
     </subPartitionValues>
     <storageName>string</storageName>
     <registeredBusinessObjectDataList>
          <businessObjectData>
               <id>0</id>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <partitionKey>string</partitionKey>
               <partitionValue>string</partitionValue>
               <subPartitionValues>
                    <partitionValue>string</partitionValue>
               </subPartitionValues>
               <version>0</version>
               <latestVersion>true</latestVersion>
               <status>string</status>
               <storageUnits>
                    <storageUnit>
                         <storage>
                              <name>string</name>
                              <storagePlatformName>string</storagePlatformName>
                              <attributes>
                                   <attribute>
                                        <name>string</name>
                                        <value>string</value>
                                   </attribute>
                              </attributes>
                         </storage>
                         <storageDirectory>
                              <directoryPath>string</directoryPath>
                         </storageDirectory>
                         <storageFiles>
                              <storageFile>
                                   <filePath>string</filePath>
                                   <fileSizeBytes>0</fileSizeBytes>
                                   <rowCount>0</rowCount>
                              </storageFile>
                         </storageFiles>
                         <storageUnitStatus>string</storageUnitStatus>
                    </storageUnit>
               </storageUnits>
               <attributes>
                    <attribute>
                         <name>string</name>
                         <value>string</value>
                    </attribute>
               </attributes>
               <businessObjectDataParents>
                    <businessObjectDataKey>
                         <namespace>string</namespace>
                         <businessObjectDefinitionName>string</businessObjectDefinitionName>
                         <businessObjectFormatUsage>string</businessObjectFormatUsage>
                         <businessObjectFormatFileType>string</businessObjectFormatFileType>
                         <businessObjectFormatVersion>0</businessObjectFormatVersion>
                         <partitionValue>string</partitionValue>
                         <subPartitionValues>
                              <partitionValue>string</partitionValue>
                         </subPartitionValues>
                         <businessObjectDataVersion>0</businessObjectDataVersion>
                    </businessObjectDataKey>
               </businessObjectDataParents>
               <businessObjectDataChildren>
                    <businessObjectDataKey>
                         <namespace>string</namespace>
                         <businessObjectDefinitionName>string</businessObjectDefinitionName>
                         <businessObjectFormatUsage>string</businessObjectFormatUsage>
                         <businessObjectFormatFileType>string</businessObjectFormatFileType>
                         <businessObjectFormatVersion>0</businessObjectFormatVersion>
                         <partitionValue>string</partitionValue>
                         <subPartitionValues>
                              <partitionValue>string</partitionValue>
                         </subPartitionValues>
                         <businessObjectDataVersion>0</businessObjectDataVersion>
                    </businessObjectDataKey>
               </businessObjectDataChildren>
               <businessObjectDataStatusHistory>
                    <businessObjectDataStatusChangeEvent>
                         <status>string</status>
                         <eventTime>2015-12-25T00:00:00.000-05:00</eventTime>
                         <userId>string</userId>
                    </businessObjectDataStatusChangeEvent>
               </businessObjectDataStatusHistory>
          </businessObjectData>
     </registeredBusinessObjectDataList>
</businessObjectDataInvalidateUnregisteredResponse>

Response Content Type

Business Object Data Attribute

post /businessObjectDataAttributes

createBusinessObjectDataAttribute

Implementation Notes

Creates a new business object data attribute.

Requires WRITE permission on namespace

Parameter (body): the information needed to create a business object data attribute
Parameter content type: Model JSON Schema XML Example businessObjectDataAttributeCreateRequest { businessObjectDataAttributeKey (businessObjectDataAttributeKey): Values that uniquely identify a Business Object Data Attribute , businessObjectDataAttributeValue (string, optional): The value of the Business Object Data Attribute } businessObjectDataAttributeKey { namespace (string): The Namespace to which a Business Object Format is related , businessObjectDefinitionName (string): The name of the Business Object Definition to which a Business Object Format is related , businessObjectFormatUsage (string): The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions , businessObjectFormatFileType (string): A File Type known to the system that describes the file type of data stored under a Business Object Format , businessObjectFormatVersion (integer, optional): The Business Object Format Version for a previously registered Business Object Format , partitionValue (string): The Partition Value that a Business Object Data is associated with , subPartitionValues (Array[string], optional): A list of Sub-Partition values associated with a Business Object Data , businessObjectDataVersion (integer, optional): The numeric version of a Business Object Data , businessObjectDataAttributeName (string): The name of a Business Object Data Attribute } `{ "businessObjectDataAttributeKey": { "namespace": "string", "businessObjectDefinitionName": "string", "businessObjectFormatUsage": "string", "businessObjectFormatFileType": "string", "businessObjectFormatVersion": 0, "partitionValue": "string", "subPartitionValues": [ "string" ], "businessObjectDataVersion": 0, "businessObjectDataAttributeName": "string" }, "businessObjectDataAttributeValue": "string" }` Click to set as parameter value <?xml version="1.0" encoding="UTF-8"?> <businessObjectDataAttributeCreateRequest> <businessObjectDataAttributeKey> <namespace>string</namespace> <businessObjectDefinitionName>string</businessObjectDefinitionName> <businessObjectFormatUsage>string</businessObjectFormatUsage> <businessObjectFormatFileType>string</businessObjectFormatFileType> <businessObjectFormatVersion>0</businessObjectFormatVersion> <partitionValue>string</partitionValue> <subPartitionValues> <partitionValue>string</partitionValue> </subPartitionValues> <businessObjectDataVersion>0</businessObjectDataVersion> <businessObjectDataAttributeName>string</businessObjectDataAttributeName> </businessObjectDataAttributeKey> <businessObjectDataAttributeValue>string</businessObjectDataAttributeValue> </businessObjectDataAttributeCreateRequest> Click to set as parameter value

Response (Status 200)

businessObjectDataAttribute {

id (integer, optional):

The internal Id that uniquely references a Business Object Data Attribute

,

businessObjectDataAttributeKey (businessObjectDataAttributeKey):

Values that uniquely identify a Business Object Data Attribute

,

businessObjectDataAttributeValue (string, optional):

The value of the Business Object Data Attribute

}
businessObjectDataAttributeKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that a Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with a Business Object Data

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

businessObjectDataAttributeName (string):

The name of a Business Object Data Attribute

}

{
  "id": 0,
  "businessObjectDataAttributeKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "partitionValue": "string",
    "subPartitionValues": [
      "string"
    ],
    "businessObjectDataVersion": 0,
    "businessObjectDataAttributeName": "string"
  },
  "businessObjectDataAttributeValue": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataAttribute>
     <id>0</id>
     <businessObjectDataAttributeKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
          <businessObjectDataAttributeName>string</businessObjectDataAttributeName>
     </businessObjectDataAttributeKey>
     <businessObjectDataAttributeValue>string</businessObjectDataAttributeValue>
</businessObjectDataAttribute>

Response Content Type

get /businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/businessObjectDataVersions/{businessObjectDataVersion}

getBusinessObjectDataAttributes

Implementation Notes

Gets a list of keys for all existing business object data attributes for a specific business object data without subpartition values.

Requires READ permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
partitionValue	the partition value of the business object data	path	string
businessObjectDataVersion	the business object data version	path	integer

Response (Status 200)

businessObjectDataAttributeKeys {

businessObjectDataAttributeKeys (Array[businessObjectDataAttributeKey], optional)

}
businessObjectDataAttributeKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that a Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with a Business Object Data

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

businessObjectDataAttributeName (string):

The name of a Business Object Data Attribute

}

{
  "businessObjectDataAttributeKeys": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0,
      "businessObjectDataAttributeName": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataAttributeKeys>
     <businessObjectDataAttributeKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
          <businessObjectDataAttributeName>string</businessObjectDataAttributeName>
     </businessObjectDataAttributeKey>
</businessObjectDataAttributeKeys>

Response Content Type

delete /businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/businessObjectDataVersions/{businessObjectDataVersion}/businessObjectDataAttributeNames/{businessObjectDataAttributeName}

deleteBusinessObjectDataAttribute

Implementation Notes

Deletes an existing attribute for the business object data without subpartition values.

Requires WRITE permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
partitionValue	the partition value of the business object data	path	string
businessObjectDataVersion	the business object data version	path	integer
businessObjectDataAttributeName	the business object data attribute name	path	string

Response (Status 200)

businessObjectDataAttribute {

id (integer, optional):

The internal Id that uniquely references a Business Object Data Attribute

,

businessObjectDataAttributeKey (businessObjectDataAttributeKey):

Values that uniquely identify a Business Object Data Attribute

,

businessObjectDataAttributeValue (string, optional):

The value of the Business Object Data Attribute

}
businessObjectDataAttributeKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that a Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with a Business Object Data

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

businessObjectDataAttributeName (string):

The name of a Business Object Data Attribute

}

{
  "id": 0,
  "businessObjectDataAttributeKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "partitionValue": "string",
    "subPartitionValues": [
      "string"
    ],
    "businessObjectDataVersion": 0,
    "businessObjectDataAttributeName": "string"
  },
  "businessObjectDataAttributeValue": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataAttribute>
     <id>0</id>
     <businessObjectDataAttributeKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
          <businessObjectDataAttributeName>string</businessObjectDataAttributeName>
     </businessObjectDataAttributeKey>
     <businessObjectDataAttributeValue>string</businessObjectDataAttributeValue>
</businessObjectDataAttribute>

Response Content Type

get /businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/businessObjectDataVersions/{businessObjectDataVersion}/businessObjectDataAttributeNames/{businessObjectDataAttributeName}

getBusinessObjectDataAttribute

Implementation Notes

Gets an existing attribute for the business object data without subpartition values.

Requires READ permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
partitionValue	the partition value of the business object data	path	string
businessObjectDataVersion	the business object data version	path	integer
businessObjectDataAttributeName	the business object data attribute name	path	string

Response (Status 200)

businessObjectDataAttribute {

id (integer, optional):

The internal Id that uniquely references a Business Object Data Attribute

,

businessObjectDataAttributeKey (businessObjectDataAttributeKey):

Values that uniquely identify a Business Object Data Attribute

,

businessObjectDataAttributeValue (string, optional):

The value of the Business Object Data Attribute

}
businessObjectDataAttributeKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that a Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with a Business Object Data

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

businessObjectDataAttributeName (string):

The name of a Business Object Data Attribute

}

{
  "id": 0,
  "businessObjectDataAttributeKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "partitionValue": "string",
    "subPartitionValues": [
      "string"
    ],
    "businessObjectDataVersion": 0,
    "businessObjectDataAttributeName": "string"
  },
  "businessObjectDataAttributeValue": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataAttribute>
     <id>0</id>
     <businessObjectDataAttributeKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
          <businessObjectDataAttributeName>string</businessObjectDataAttributeName>
     </businessObjectDataAttributeKey>
     <businessObjectDataAttributeValue>string</businessObjectDataAttributeValue>
</businessObjectDataAttribute>

Response Content Type

put /businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/businessObjectDataVersions/{businessObjectDataVersion}/businessObjectDataAttributeNames/{businessObjectDataAttributeName}

updateBusinessObjectDataAttribute

Implementation Notes

Updates an existing attribute for the business object data without subpartition values.

Requires WRITE permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace	path	string
businessObjectDefinitionName		the business object definition name	path	string
businessObjectFormatUsage		the business object format usage	path	string
businessObjectFormatFileType		the business object format file type	path	string
businessObjectFormatVersion		the business object format version	path	integer
partitionValue		the partition value of the business object data	path	string
businessObjectDataVersion		the business object data version	path	integer
businessObjectDataAttributeName		the business object data attribute name	path	string
businessObjectDataAttributeUpdateRequest: the request information needed to update the business object data attribute	Parameter content type: Model JSON Schema XML Example businessObjectDataAttributeUpdateRequest { businessObjectDataAttributeValue (string, optional): The value of the Business Object Data Attribute } `{ "businessObjectDataAttributeValue": "string" }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <businessObjectDataAttributeUpdateRequest> <businessObjectDataAttributeValue>string</businessObjectDataAttributeValue> </businessObjectDataAttributeUpdateRequest>` Click to set as parameter value

Response (Status 200)

businessObjectDataAttribute {

id (integer, optional):

The internal Id that uniquely references a Business Object Data Attribute

,

businessObjectDataAttributeKey (businessObjectDataAttributeKey):

Values that uniquely identify a Business Object Data Attribute

,

businessObjectDataAttributeValue (string, optional):

The value of the Business Object Data Attribute

}
businessObjectDataAttributeKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that a Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with a Business Object Data

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

businessObjectDataAttributeName (string):

The name of a Business Object Data Attribute

}

{
  "id": 0,
  "businessObjectDataAttributeKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "partitionValue": "string",
    "subPartitionValues": [
      "string"
    ],
    "businessObjectDataVersion": 0,
    "businessObjectDataAttributeName": "string"
  },
  "businessObjectDataAttributeValue": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataAttribute>
     <id>0</id>
     <businessObjectDataAttributeKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
          <businessObjectDataAttributeName>string</businessObjectDataAttributeName>
     </businessObjectDataAttributeKey>
     <businessObjectDataAttributeValue>string</businessObjectDataAttributeValue>
</businessObjectDataAttribute>

Response Content Type

get /businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/businessObjectDataVersions/{businessObjectDataVersion}

getBusinessObjectDataAttributes

Implementation Notes

Gets a list of keys for all existing business object data attributes for a specific business object data with 1 subpartition value.

Requires READ permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
partitionValue	the primary partition value of the business object data	path	string
subPartition1Value	the 1st subpartition value of the business object data	path	string
businessObjectDataVersion	the business object data version	path	integer

Response (Status 200)

businessObjectDataAttributeKeys {

businessObjectDataAttributeKeys (Array[businessObjectDataAttributeKey], optional)

}
businessObjectDataAttributeKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that a Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with a Business Object Data

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

businessObjectDataAttributeName (string):

The name of a Business Object Data Attribute

}

{
  "businessObjectDataAttributeKeys": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0,
      "businessObjectDataAttributeName": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataAttributeKeys>
     <businessObjectDataAttributeKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
          <businessObjectDataAttributeName>string</businessObjectDataAttributeName>
     </businessObjectDataAttributeKey>
</businessObjectDataAttributeKeys>

Response Content Type

delete /businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/businessObjectDataVersions/{businessObjectDataVersion}/businessObjectDataAttributeNames/{businessObjectDataAttributeName}

deleteBusinessObjectDataAttribute

Implementation Notes

Deletes an existing attribute for the business object data with 1 subpartition value.

Requires WRITE permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
partitionValue	the primary partition value of the business object data	path	string
subPartition1Value	the 1st subpartition value of the business object data	path	string
businessObjectDataVersion	the business object data version	path	integer
businessObjectDataAttributeName	the business object data attribute name	path	string

Response (Status 200)

businessObjectDataAttribute {

id (integer, optional):

The internal Id that uniquely references a Business Object Data Attribute

,

businessObjectDataAttributeKey (businessObjectDataAttributeKey):

Values that uniquely identify a Business Object Data Attribute

,

businessObjectDataAttributeValue (string, optional):

The value of the Business Object Data Attribute

}
businessObjectDataAttributeKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that a Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with a Business Object Data

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

businessObjectDataAttributeName (string):

The name of a Business Object Data Attribute

}

{
  "id": 0,
  "businessObjectDataAttributeKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "partitionValue": "string",
    "subPartitionValues": [
      "string"
    ],
    "businessObjectDataVersion": 0,
    "businessObjectDataAttributeName": "string"
  },
  "businessObjectDataAttributeValue": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataAttribute>
     <id>0</id>
     <businessObjectDataAttributeKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
          <businessObjectDataAttributeName>string</businessObjectDataAttributeName>
     </businessObjectDataAttributeKey>
     <businessObjectDataAttributeValue>string</businessObjectDataAttributeValue>
</businessObjectDataAttribute>

Response Content Type

get /businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/businessObjectDataVersions/{businessObjectDataVersion}/businessObjectDataAttributeNames/{businessObjectDataAttributeName}

getBusinessObjectDataAttribute

Implementation Notes

Gets an existing attribute for the business object data with 1 subpartition values.

Requires READ permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
partitionValue	the primary partition value of the business object data	path	string
subPartition1Value	the 1st subpartition value of the business object data	path	string
businessObjectDataVersion	the business object data version	path	integer
businessObjectDataAttributeName	the business object data attribute name	path	string

Response (Status 200)

businessObjectDataAttribute {

id (integer, optional):

The internal Id that uniquely references a Business Object Data Attribute

,

businessObjectDataAttributeKey (businessObjectDataAttributeKey):

Values that uniquely identify a Business Object Data Attribute

,

businessObjectDataAttributeValue (string, optional):

The value of the Business Object Data Attribute

}
businessObjectDataAttributeKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that a Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with a Business Object Data

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

businessObjectDataAttributeName (string):

The name of a Business Object Data Attribute

}

{
  "id": 0,
  "businessObjectDataAttributeKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "partitionValue": "string",
    "subPartitionValues": [
      "string"
    ],
    "businessObjectDataVersion": 0,
    "businessObjectDataAttributeName": "string"
  },
  "businessObjectDataAttributeValue": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataAttribute>
     <id>0</id>
     <businessObjectDataAttributeKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
          <businessObjectDataAttributeName>string</businessObjectDataAttributeName>
     </businessObjectDataAttributeKey>
     <businessObjectDataAttributeValue>string</businessObjectDataAttributeValue>
</businessObjectDataAttribute>

Response Content Type

put /businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/businessObjectDataVersions/{businessObjectDataVersion}/businessObjectDataAttributeNames/{businessObjectDataAttributeName}

updateBusinessObjectDataAttribute

Implementation Notes

Updates an existing attribute for the business object data with 1 subpartition value.

Requires WRITE permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace	path	string
businessObjectDefinitionName		the business object definition name	path	string
businessObjectFormatUsage		the business object format usage	path	string
businessObjectFormatFileType		the business object format file type	path	string
businessObjectFormatVersion		the business object format version	path	integer
partitionValue		the primary partition value of the business object data	path	string
subPartition1Value		the 1st subpartition value of the business object data	path	string
businessObjectDataVersion		the business object data version	path	integer
businessObjectDataAttributeName		the business object data attribute name	path	string
businessObjectDataAttributeUpdateRequest: the request information needed to update the business object data attribute	Parameter content type: Model JSON Schema XML Example businessObjectDataAttributeUpdateRequest { businessObjectDataAttributeValue (string, optional): The value of the Business Object Data Attribute } `{ "businessObjectDataAttributeValue": "string" }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <businessObjectDataAttributeUpdateRequest> <businessObjectDataAttributeValue>string</businessObjectDataAttributeValue> </businessObjectDataAttributeUpdateRequest>` Click to set as parameter value

Response (Status 200)

businessObjectDataAttribute {

id (integer, optional):

The internal Id that uniquely references a Business Object Data Attribute

,

businessObjectDataAttributeKey (businessObjectDataAttributeKey):

Values that uniquely identify a Business Object Data Attribute

,

businessObjectDataAttributeValue (string, optional):

The value of the Business Object Data Attribute

}
businessObjectDataAttributeKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that a Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with a Business Object Data

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

businessObjectDataAttributeName (string):

The name of a Business Object Data Attribute

}

{
  "id": 0,
  "businessObjectDataAttributeKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "partitionValue": "string",
    "subPartitionValues": [
      "string"
    ],
    "businessObjectDataVersion": 0,
    "businessObjectDataAttributeName": "string"
  },
  "businessObjectDataAttributeValue": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataAttribute>
     <id>0</id>
     <businessObjectDataAttributeKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
          <businessObjectDataAttributeName>string</businessObjectDataAttributeName>
     </businessObjectDataAttributeKey>
     <businessObjectDataAttributeValue>string</businessObjectDataAttributeValue>
</businessObjectDataAttribute>

Response Content Type

get /businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/subPartition2Values/{subPartition2Value}/businessObjectDataVersions/{businessObjectDataVersion}

getBusinessObjectDataAttributes

Implementation Notes

Gets a list of keys for all existing business object data attributes for a specific business object data with 2 subpartition values.

Requires READ permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
partitionValue	the primary partition value of the business object data	path	string
subPartition1Value	the 1st subpartition value of the business object data	path	string
subPartition2Value	the 2nd subpartition value of the business object data	path	string
businessObjectDataVersion	the business object data version	path	integer

Response (Status 200)

businessObjectDataAttributeKeys {

businessObjectDataAttributeKeys (Array[businessObjectDataAttributeKey], optional)

}
businessObjectDataAttributeKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that a Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with a Business Object Data

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

businessObjectDataAttributeName (string):

The name of a Business Object Data Attribute

}

{
  "businessObjectDataAttributeKeys": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0,
      "businessObjectDataAttributeName": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataAttributeKeys>
     <businessObjectDataAttributeKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
          <businessObjectDataAttributeName>string</businessObjectDataAttributeName>
     </businessObjectDataAttributeKey>
</businessObjectDataAttributeKeys>

Response Content Type

delete /businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/subPartition2Values/{subPartition2Value}/businessObjectDataVersions/{businessObjectDataVersion}/businessObjectDataAttributeNames/{businessObjectDataAttributeName}

deleteBusinessObjectDataAttribute

Implementation Notes

Deletes an existing attribute for the business object data with 2 subpartition values.

Requires WRITE permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
partitionValue	the primary partition value of the business object data	path	string
subPartition1Value	the 1st subpartition value of the business object data	path	string
subPartition2Value	the 2nd subpartition value of the business object data	path	string
businessObjectDataVersion	the business object data version	path	integer
businessObjectDataAttributeName	the business object data attribute name	path	string

Response (Status 200)

businessObjectDataAttribute {

id (integer, optional):

The internal Id that uniquely references a Business Object Data Attribute

,

businessObjectDataAttributeKey (businessObjectDataAttributeKey):

Values that uniquely identify a Business Object Data Attribute

,

businessObjectDataAttributeValue (string, optional):

The value of the Business Object Data Attribute

}
businessObjectDataAttributeKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that a Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with a Business Object Data

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

businessObjectDataAttributeName (string):

The name of a Business Object Data Attribute

}

{
  "id": 0,
  "businessObjectDataAttributeKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "partitionValue": "string",
    "subPartitionValues": [
      "string"
    ],
    "businessObjectDataVersion": 0,
    "businessObjectDataAttributeName": "string"
  },
  "businessObjectDataAttributeValue": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataAttribute>
     <id>0</id>
     <businessObjectDataAttributeKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
          <businessObjectDataAttributeName>string</businessObjectDataAttributeName>
     </businessObjectDataAttributeKey>
     <businessObjectDataAttributeValue>string</businessObjectDataAttributeValue>
</businessObjectDataAttribute>

Response Content Type

get /businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/subPartition2Values/{subPartition2Value}/businessObjectDataVersions/{businessObjectDataVersion}/businessObjectDataAttributeNames/{businessObjectDataAttributeName}

getBusinessObjectDataAttribute

Implementation Notes

Gets an existing attribute for the business object data with 2 subpartition values.

Requires READ permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
partitionValue	the primary partition value of the business object data	path	string
subPartition1Value	the 1st subpartition value of the business object data	path	string
subPartition2Value	the 2nd subpartition value of the business object data	path	string
businessObjectDataVersion	the business object data version	path	integer
businessObjectDataAttributeName	the business object data attribute name	path	string

Response (Status 200)

businessObjectDataAttribute {

id (integer, optional):

The internal Id that uniquely references a Business Object Data Attribute

,

businessObjectDataAttributeKey (businessObjectDataAttributeKey):

Values that uniquely identify a Business Object Data Attribute

,

businessObjectDataAttributeValue (string, optional):

The value of the Business Object Data Attribute

}
businessObjectDataAttributeKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that a Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with a Business Object Data

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

businessObjectDataAttributeName (string):

The name of a Business Object Data Attribute

}

{
  "id": 0,
  "businessObjectDataAttributeKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "partitionValue": "string",
    "subPartitionValues": [
      "string"
    ],
    "businessObjectDataVersion": 0,
    "businessObjectDataAttributeName": "string"
  },
  "businessObjectDataAttributeValue": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataAttribute>
     <id>0</id>
     <businessObjectDataAttributeKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
          <businessObjectDataAttributeName>string</businessObjectDataAttributeName>
     </businessObjectDataAttributeKey>
     <businessObjectDataAttributeValue>string</businessObjectDataAttributeValue>
</businessObjectDataAttribute>

Response Content Type

put /businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/subPartition2Values/{subPartition2Value}/businessObjectDataVersions/{businessObjectDataVersion}/businessObjectDataAttributeNames/{businessObjectDataAttributeName}

updateBusinessObjectDataAttribute

Implementation Notes

Updates an existing attribute for the business object data with 2 subpartition values.

Requires WRITE permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace	path	string
businessObjectDefinitionName		the business object definition name	path	string
businessObjectFormatUsage		the business object format usage	path	string
businessObjectFormatFileType		the business object format file type	path	string
businessObjectFormatVersion		the business object format version	path	integer
partitionValue		the primary partition value of the business object data	path	string
subPartition1Value		the 1st subpartition value of the business object data	path	string
subPartition2Value		the 2nd subpartition value of the business object data	path	string
businessObjectDataVersion		the business object data version	path	integer
businessObjectDataAttributeName		the business object data attribute name	path	string
businessObjectDataAttributeUpdateRequest: the request information needed to update the business object data attribute	Parameter content type: Model JSON Schema XML Example businessObjectDataAttributeUpdateRequest { businessObjectDataAttributeValue (string, optional): The value of the Business Object Data Attribute } `{ "businessObjectDataAttributeValue": "string" }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <businessObjectDataAttributeUpdateRequest> <businessObjectDataAttributeValue>string</businessObjectDataAttributeValue> </businessObjectDataAttributeUpdateRequest>` Click to set as parameter value

Response (Status 200)

businessObjectDataAttribute {

id (integer, optional):

The internal Id that uniquely references a Business Object Data Attribute

,

businessObjectDataAttributeKey (businessObjectDataAttributeKey):

Values that uniquely identify a Business Object Data Attribute

,

businessObjectDataAttributeValue (string, optional):

The value of the Business Object Data Attribute

}
businessObjectDataAttributeKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that a Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with a Business Object Data

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

businessObjectDataAttributeName (string):

The name of a Business Object Data Attribute

}

{
  "id": 0,
  "businessObjectDataAttributeKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "partitionValue": "string",
    "subPartitionValues": [
      "string"
    ],
    "businessObjectDataVersion": 0,
    "businessObjectDataAttributeName": "string"
  },
  "businessObjectDataAttributeValue": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataAttribute>
     <id>0</id>
     <businessObjectDataAttributeKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
          <businessObjectDataAttributeName>string</businessObjectDataAttributeName>
     </businessObjectDataAttributeKey>
     <businessObjectDataAttributeValue>string</businessObjectDataAttributeValue>
</businessObjectDataAttribute>

Response Content Type

get /businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/subPartition2Values/{subPartition2Value}/subPartition3Values/{subPartition3Value}/businessObjectDataVersions/{businessObjectDataVersion}

getBusinessObjectDataAttributes

Implementation Notes

Gets a list of keys for all existing business object data attributes for a specific business object data with 3 subpartition values.

Requires READ permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
partitionValue	the primary partition value of the business object data	path	string
subPartition1Value	the 1st subpartition value of the business object data	path	string
subPartition2Value	the 2nd subpartition value of the business object data	path	string
subPartition3Value	the 3rd subpartition value of the business object data	path	string
businessObjectDataVersion	the business object data version	path	integer

Response (Status 200)

businessObjectDataAttributeKeys {

businessObjectDataAttributeKeys (Array[businessObjectDataAttributeKey], optional)

}
businessObjectDataAttributeKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that a Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with a Business Object Data

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

businessObjectDataAttributeName (string):

The name of a Business Object Data Attribute

}

{
  "businessObjectDataAttributeKeys": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0,
      "businessObjectDataAttributeName": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataAttributeKeys>
     <businessObjectDataAttributeKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
          <businessObjectDataAttributeName>string</businessObjectDataAttributeName>
     </businessObjectDataAttributeKey>
</businessObjectDataAttributeKeys>

Response Content Type

delete /businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/subPartition2Values/{subPartition2Value}/subPartition3Values/{subPartition3Value}/businessObjectDataVersions/{businessObjectDataVersion}/businessObjectDataAttributeNames/{businessObjectDataAttributeName}

deleteBusinessObjectDataAttribute

Implementation Notes

Deletes an existing attribute for the business object data with 3 subpartition values.

Requires WRITE permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
partitionValue	the primary partition value of the business object data	path	string
subPartition1Value	the 1st subpartition value of the business object data	path	string
subPartition2Value	the 2nd subpartition value of the business object data	path	string
subPartition3Value	the 3rd subpartition value of the business object data	path	string
businessObjectDataVersion	the business object data version	path	integer
businessObjectDataAttributeName	the business object data attribute name	path	string

Response (Status 200)

businessObjectDataAttribute {

id (integer, optional):

The internal Id that uniquely references a Business Object Data Attribute

,

businessObjectDataAttributeKey (businessObjectDataAttributeKey):

Values that uniquely identify a Business Object Data Attribute

,

businessObjectDataAttributeValue (string, optional):

The value of the Business Object Data Attribute

}
businessObjectDataAttributeKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that a Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with a Business Object Data

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

businessObjectDataAttributeName (string):

The name of a Business Object Data Attribute

}

{
  "id": 0,
  "businessObjectDataAttributeKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "partitionValue": "string",
    "subPartitionValues": [
      "string"
    ],
    "businessObjectDataVersion": 0,
    "businessObjectDataAttributeName": "string"
  },
  "businessObjectDataAttributeValue": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataAttribute>
     <id>0</id>
     <businessObjectDataAttributeKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
          <businessObjectDataAttributeName>string</businessObjectDataAttributeName>
     </businessObjectDataAttributeKey>
     <businessObjectDataAttributeValue>string</businessObjectDataAttributeValue>
</businessObjectDataAttribute>

Response Content Type

get /businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/subPartition2Values/{subPartition2Value}/subPartition3Values/{subPartition3Value}/businessObjectDataVersions/{businessObjectDataVersion}/businessObjectDataAttributeNames/{businessObjectDataAttributeName}

getBusinessObjectDataAttribute

Implementation Notes

Gets an existing attribute for the business object data with 3 subpartition values.

Requires READ permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
partitionValue	the primary partition value of the business object data	path	string
subPartition1Value	the 1st subpartition value of the business object data	path	string
subPartition2Value	the 2nd subpartition value of the business object data	path	string
subPartition3Value	the 3rd subpartition value of the business object data	path	string
businessObjectDataVersion	the business object data version	path	integer
businessObjectDataAttributeName	the business object data attribute name	path	string

Response (Status 200)

businessObjectDataAttribute {

id (integer, optional):

The internal Id that uniquely references a Business Object Data Attribute

,

businessObjectDataAttributeKey (businessObjectDataAttributeKey):

Values that uniquely identify a Business Object Data Attribute

,

businessObjectDataAttributeValue (string, optional):

The value of the Business Object Data Attribute

}
businessObjectDataAttributeKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that a Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with a Business Object Data

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

businessObjectDataAttributeName (string):

The name of a Business Object Data Attribute

}

{
  "id": 0,
  "businessObjectDataAttributeKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "partitionValue": "string",
    "subPartitionValues": [
      "string"
    ],
    "businessObjectDataVersion": 0,
    "businessObjectDataAttributeName": "string"
  },
  "businessObjectDataAttributeValue": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataAttribute>
     <id>0</id>
     <businessObjectDataAttributeKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
          <businessObjectDataAttributeName>string</businessObjectDataAttributeName>
     </businessObjectDataAttributeKey>
     <businessObjectDataAttributeValue>string</businessObjectDataAttributeValue>
</businessObjectDataAttribute>

Response Content Type

put /businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/subPartition2Values/{subPartition2Value}/subPartition3Values/{subPartition3Value}/businessObjectDataVersions/{businessObjectDataVersion}/businessObjectDataAttributeNames/{businessObjectDataAttributeName}

updateBusinessObjectDataAttribute

Implementation Notes

Updates an existing attribute for the business object data with 3 subpartition values.

Requires WRITE permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace	path	string
businessObjectDefinitionName		the business object definition name	path	string
businessObjectFormatUsage		the business object format usage	path	string
businessObjectFormatFileType		the business object format file type	path	string
businessObjectFormatVersion		the business object format version	path	integer
partitionValue		the primary partition value of the business object data	path	string
subPartition1Value		the 1st subpartition value of the business object data	path	string
subPartition2Value		the 2nd subpartition value of the business object data	path	string
subPartition3Value		the 3rd subpartition value of the business object data	path	string
businessObjectDataVersion		the business object data version	path	integer
businessObjectDataAttributeName		the business object data attribute name	path	string
businessObjectDataAttributeUpdateRequest: the request information needed to update the business object data attribute	Parameter content type: Model JSON Schema XML Example businessObjectDataAttributeUpdateRequest { businessObjectDataAttributeValue (string, optional): The value of the Business Object Data Attribute } `{ "businessObjectDataAttributeValue": "string" }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <businessObjectDataAttributeUpdateRequest> <businessObjectDataAttributeValue>string</businessObjectDataAttributeValue> </businessObjectDataAttributeUpdateRequest>` Click to set as parameter value

Response (Status 200)

businessObjectDataAttribute {

id (integer, optional):

The internal Id that uniquely references a Business Object Data Attribute

,

businessObjectDataAttributeKey (businessObjectDataAttributeKey):

Values that uniquely identify a Business Object Data Attribute

,

businessObjectDataAttributeValue (string, optional):

The value of the Business Object Data Attribute

}
businessObjectDataAttributeKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that a Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with a Business Object Data

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

businessObjectDataAttributeName (string):

The name of a Business Object Data Attribute

}

{
  "id": 0,
  "businessObjectDataAttributeKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "partitionValue": "string",
    "subPartitionValues": [
      "string"
    ],
    "businessObjectDataVersion": 0,
    "businessObjectDataAttributeName": "string"
  },
  "businessObjectDataAttributeValue": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataAttribute>
     <id>0</id>
     <businessObjectDataAttributeKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
          <businessObjectDataAttributeName>string</businessObjectDataAttributeName>
     </businessObjectDataAttributeKey>
     <businessObjectDataAttributeValue>string</businessObjectDataAttributeValue>
</businessObjectDataAttribute>

Response Content Type

get /businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/subPartition2Values/{subPartition2Value}/subPartition3Values/{subPartition3Value}/subPartition4Values/{subPartition4Value}/businessObjectDataVersions/{businessObjectDataVersion}

getBusinessObjectDataAttributes

Implementation Notes

Gets a list of keys for all existing business object data attributes for a specific business object data with 4 subpartition values.

Requires READ permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
partitionValue	the primary partition value of the business object data	path	string
subPartition1Value	the 1st subpartition value of the business object data	path	string
subPartition2Value	the 2nd subpartition value of the business object data	path	string
subPartition3Value	the 3rd subpartition value of the business object data	path	string
subPartition4Value	the 4th subpartition value of the business object data	path	string
businessObjectDataVersion	the business object data version	path	integer

Response (Status 200)

businessObjectDataAttributeKeys {

businessObjectDataAttributeKeys (Array[businessObjectDataAttributeKey], optional)

}
businessObjectDataAttributeKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that a Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with a Business Object Data

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

businessObjectDataAttributeName (string):

The name of a Business Object Data Attribute

}

{
  "businessObjectDataAttributeKeys": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0,
      "partitionValue": "string",
      "subPartitionValues": [
        "string"
      ],
      "businessObjectDataVersion": 0,
      "businessObjectDataAttributeName": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataAttributeKeys>
     <businessObjectDataAttributeKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
          <businessObjectDataAttributeName>string</businessObjectDataAttributeName>
     </businessObjectDataAttributeKey>
</businessObjectDataAttributeKeys>

Response Content Type

delete /businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/subPartition2Values/{subPartition2Value}/subPartition3Values/{subPartition3Value}/subPartition4Values/{subPartition4Value}/businessObjectDataVersions/{businessObjectDataVersion}/businessObjectDataAttributeNames/{businessObjectDataAttributeName}

deleteBusinessObjectDataAttribute

Implementation Notes

Deletes an existing attribute for the business object data with 4 subpartition values.

Requires WRITE permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
partitionValue	the primary partition value of the business object data	path	string
subPartition1Value	the 1st subpartition value of the business object data	path	string
subPartition2Value	the 2nd subpartition value of the business object data	path	string
subPartition3Value	the 3rd subpartition value of the business object data	path	string
subPartition4Value	the 4th subpartition value of the business object data	path	string
businessObjectDataVersion	the business object data version	path	integer
businessObjectDataAttributeName	the business object data attribute name	path	string

Response (Status 200)

businessObjectDataAttribute {

id (integer, optional):

The internal Id that uniquely references a Business Object Data Attribute

,

businessObjectDataAttributeKey (businessObjectDataAttributeKey):

Values that uniquely identify a Business Object Data Attribute

,

businessObjectDataAttributeValue (string, optional):

The value of the Business Object Data Attribute

}
businessObjectDataAttributeKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that a Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with a Business Object Data

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

businessObjectDataAttributeName (string):

The name of a Business Object Data Attribute

}

{
  "id": 0,
  "businessObjectDataAttributeKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "partitionValue": "string",
    "subPartitionValues": [
      "string"
    ],
    "businessObjectDataVersion": 0,
    "businessObjectDataAttributeName": "string"
  },
  "businessObjectDataAttributeValue": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataAttribute>
     <id>0</id>
     <businessObjectDataAttributeKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
          <businessObjectDataAttributeName>string</businessObjectDataAttributeName>
     </businessObjectDataAttributeKey>
     <businessObjectDataAttributeValue>string</businessObjectDataAttributeValue>
</businessObjectDataAttribute>

Response Content Type

get /businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/subPartition2Values/{subPartition2Value}/subPartition3Values/{subPartition3Value}/subPartition4Values/{subPartition4Value}/businessObjectDataVersions/{businessObjectDataVersion}/businessObjectDataAttributeNames/{businessObjectDataAttributeName}

getBusinessObjectDataAttribute

Implementation Notes

Gets an existing attribute for the business object data with 4 subpartition values.

Requires READ permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
partitionValue	the primary partition value of the business object data	path	string
subPartition1Value	the 1st subpartition value of the business object data	path	string
subPartition2Value	the 2nd subpartition value of the business object data	path	string
subPartition3Value	the 3rd subpartition value of the business object data	path	string
subPartition4Value	the 4th subpartition value of the business object data	path	string
businessObjectDataVersion	the business object data version	path	integer
businessObjectDataAttributeName	the business object data attribute name	path	string

Response (Status 200)

businessObjectDataAttribute {

id (integer, optional):

The internal Id that uniquely references a Business Object Data Attribute

,

businessObjectDataAttributeKey (businessObjectDataAttributeKey):

Values that uniquely identify a Business Object Data Attribute

,

businessObjectDataAttributeValue (string, optional):

The value of the Business Object Data Attribute

}
businessObjectDataAttributeKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that a Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with a Business Object Data

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

businessObjectDataAttributeName (string):

The name of a Business Object Data Attribute

}

{
  "id": 0,
  "businessObjectDataAttributeKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "partitionValue": "string",
    "subPartitionValues": [
      "string"
    ],
    "businessObjectDataVersion": 0,
    "businessObjectDataAttributeName": "string"
  },
  "businessObjectDataAttributeValue": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataAttribute>
     <id>0</id>
     <businessObjectDataAttributeKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
          <businessObjectDataAttributeName>string</businessObjectDataAttributeName>
     </businessObjectDataAttributeKey>
     <businessObjectDataAttributeValue>string</businessObjectDataAttributeValue>
</businessObjectDataAttribute>

Response Content Type

put /businessObjectDataAttributes/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/subPartition2Values/{subPartition2Value}/subPartition3Values/{subPartition3Value}/subPartition4Values/{subPartition4Value}/businessObjectDataVersions/{businessObjectDataVersion}/businessObjectDataAttributeNames/{businessObjectDataAttributeName}

updateBusinessObjectDataAttribute

Implementation Notes

Updates an existing attribute for the business object data with 4 subpartition values.

Requires WRITE permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace	path	string
businessObjectDefinitionName		the business object definition name	path	string
businessObjectFormatUsage		the business object format usage	path	string
businessObjectFormatFileType		the business object format file type	path	string
businessObjectFormatVersion		the business object format version	path	integer
partitionValue		the primary partition value of the business object data	path	string
subPartition1Value		the 1st subpartition value of the business object data	path	string
subPartition2Value		the 2nd subpartition value of the business object data	path	string
subPartition3Value		the 3rd subpartition value of the business object data	path	string
subPartition4Value		the 4th subpartition value of the business object data	path	string
businessObjectDataVersion		the business object data version	path	integer
businessObjectDataAttributeName		the business object data attribute name	path	string
businessObjectDataAttributeUpdateRequest: the request information needed to update the business object data attribute	Parameter content type: Model JSON Schema XML Example businessObjectDataAttributeUpdateRequest { businessObjectDataAttributeValue (string, optional): The value of the Business Object Data Attribute } `{ "businessObjectDataAttributeValue": "string" }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <businessObjectDataAttributeUpdateRequest> <businessObjectDataAttributeValue>string</businessObjectDataAttributeValue> </businessObjectDataAttributeUpdateRequest>` Click to set as parameter value

Response (Status 200)

businessObjectDataAttribute {

id (integer, optional):

The internal Id that uniquely references a Business Object Data Attribute

,

businessObjectDataAttributeKey (businessObjectDataAttributeKey):

Values that uniquely identify a Business Object Data Attribute

,

businessObjectDataAttributeValue (string, optional):

The value of the Business Object Data Attribute

}
businessObjectDataAttributeKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of a Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that a Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with a Business Object Data

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

,

businessObjectDataAttributeName (string):

The name of a Business Object Data Attribute

}

{
  "id": 0,
  "businessObjectDataAttributeKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "partitionValue": "string",
    "subPartitionValues": [
      "string"
    ],
    "businessObjectDataVersion": 0,
    "businessObjectDataAttributeName": "string"
  },
  "businessObjectDataAttributeValue": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataAttribute>
     <id>0</id>
     <businessObjectDataAttributeKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
          <businessObjectDataAttributeName>string</businessObjectDataAttributeName>
     </businessObjectDataAttributeKey>
     <businessObjectDataAttributeValue>string</businessObjectDataAttributeValue>
</businessObjectDataAttribute>

Response Content Type

Business Object Data Notification Registration

get /notificationRegistrations/businessObjectDataNotificationRegistrations

getBusinessObjectDataNotificationRegistrationsByNotificationFilter

Implementation Notes

Gets a list of keys for all existing business object data notification registrations that match the specified business object data notification filter parameters.

This endpoint requires both namespace and name of the business object definition.

Requires READ permission on business object definition namespace

Parameters

Parameter	Description	Parameter Type	Data Type
businessObjectDefinitionNamespace	the namespace of the business object definition	query	string
businessObjectDefinitionName	the name of the business object definition	query	string
businessObjectFormatUsage	the usage of the business object format	query	string
businessObjectFormatFileType	the file type of the business object format	query	string

Response (Status 200)

businessObjectDataNotificationRegistrationKeys {

businessObjectDataNotificationRegistrationKeys (Array[notificationRegistrationKey], optional)

}
notificationRegistrationKey {

namespace (string),

notificationName (string)

}

{
  "businessObjectDataNotificationRegistrationKeys": [
    {
      "namespace": "string",
      "notificationName": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataNotificationRegistrationKeys>
     <businessObjectDataNotificationRegistrationKey>
          <namespace>string</namespace>
          <notificationName>string</notificationName>
     </businessObjectDataNotificationRegistrationKey>
</businessObjectDataNotificationRegistrationKeys>

Response Content Type

post /notificationRegistrations/businessObjectDataNotificationRegistrations

createBusinessObjectDataNotificationRegistration

Implementation Notes

Creates a new business object data notification.

Requires WRITE permission on namespace

Requires READ permission on filter namespace

Requires EXECUTE permission on ALL job action namespaces

Parameter (body): the information needed to create the business object data notification
Parameter content type: Model JSON Schema XML Example businessObjectDataNotificationRegistrationCreateRequest { businessObjectDataNotificationRegistrationKey (notificationRegistrationKey): A unique identifier for a business object data notification registration , businessObjectDataEventType (string): The type of business object data event in which this notification should trigger , businessObjectDataNotificationFilter (businessObjectDataNotificationFilter): The filter to use against business object data events. The notification will only trigger for events matching this filter. , jobActions (Array[jobAction], optional): The list of jobs to execute when this notification is triggered , notificationRegistrationStatus (string, optional): The status of the notification registration } notificationRegistrationKey { namespace (string), notificationName (string) } businessObjectDataNotificationFilter { namespace (string): The namespace of the business object definition , businessObjectDefinitionName (string): The business object definition name , businessObjectFormatUsage (string, optional): The business object format usage , businessObjectFormatFileType (string, optional): The business object format file type , businessObjectFormatVersion (integer, optional): The business object format version , storageName (string, optional): The storage name , newBusinessObjectDataStatus (string, optional): The new business object data status , oldBusinessObjectDataStatus (string, optional): The old business object data status } jobAction { namespace (string): The namespace , jobName (string): The job name , correlationData (string, optional): The correlation data } { "businessObjectDataNotificationRegistrationKey": { "namespace": "string", "notificationName": "string" }, "businessObjectDataEventType": "string", "businessObjectDataNotificationFilter": { "namespace": "string", "businessObjectDefinitionName": "string", "businessObjectFormatUsage": "string", "businessObjectFormatFileType": "string", "businessObjectFormatVersion": 0, "storageName": "string", "newBusinessObjectDataStatus": "string", "oldBusinessObjectDataStatus": "string" }, "jobActions": [ { "namespace": "string", "jobName": "string", "correlationData": "string" } ], "notificationRegistrationStatus": "string" } Click to set as parameter value <?xml version="1.0" encoding="UTF-8"?> <businessObjectDataNotificationRegistrationCreateRequest> <businessObjectDataNotificationRegistrationKey> <namespace>string</namespace> <notificationName>string</notificationName> </businessObjectDataNotificationRegistrationKey> <businessObjectDataEventType>string</businessObjectDataEventType> <businessObjectDataNotificationFilter> <namespace>string</namespace> <businessObjectDefinitionName>string</businessObjectDefinitionName> <businessObjectFormatUsage>string</businessObjectFormatUsage> <businessObjectFormatFileType>string</businessObjectFormatFileType> <businessObjectFormatVersion>0</businessObjectFormatVersion> <storageName>string</storageName> <newBusinessObjectDataStatus>string</newBusinessObjectDataStatus> <oldBusinessObjectDataStatus>string</oldBusinessObjectDataStatus> </businessObjectDataNotificationFilter> <jobActions> <jobAction> <namespace>string</namespace> <jobName>string</jobName> <correlationData> <![CDATA[ string]]> </correlationData> </jobAction> </jobActions> <notificationRegistrationStatus>string</notificationRegistrationStatus> </businessObjectDataNotificationRegistrationCreateRequest> Click to set as parameter value

Response (Status 200)

businessObjectDataNotificationRegistration {

id (integer, optional):

A system unique ID of this registration

,

businessObjectDataNotificationRegistrationKey (notificationRegistrationKey):

A unique identifier for a business object data notification registration

,

businessObjectDataEventType (string):

The type of business object data event in which this notification should trigger

,

businessObjectDataNotificationFilter (businessObjectDataNotificationFilter):

The filter to use against business object data events

,

jobActions (Array[jobAction], optional):

The list of jobs to execute when this notification is triggered

,

notificationRegistrationStatus (string):

The status of the notification registration

}
notificationRegistrationKey {

namespace (string),

notificationName (string)

}
businessObjectDataNotificationFilter {

namespace (string):

The namespace of the business object definition

,

businessObjectDefinitionName (string):

The business object definition name

,

businessObjectFormatUsage (string, optional):

The business object format usage

,

businessObjectFormatFileType (string, optional):

The business object format file type

,

businessObjectFormatVersion (integer, optional):

The business object format version

,

storageName (string, optional):

The storage name

,

newBusinessObjectDataStatus (string, optional):

The new business object data status

,

oldBusinessObjectDataStatus (string, optional):

The old business object data status

}
jobAction {

namespace (string):

The namespace

,

jobName (string):

The job name

,

correlationData (string, optional):

The correlation data

}

{
  "id": 0,
  "businessObjectDataNotificationRegistrationKey": {
    "namespace": "string",
    "notificationName": "string"
  },
  "businessObjectDataEventType": "string",
  "businessObjectDataNotificationFilter": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "storageName": "string",
    "newBusinessObjectDataStatus": "string",
    "oldBusinessObjectDataStatus": "string"
  },
  "jobActions": [
    {
      "namespace": "string",
      "jobName": "string",
      "correlationData": "string"
    }
  ],
  "notificationRegistrationStatus": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataNotificationRegistration>
     <id>0</id>
     <businessObjectDataNotificationRegistrationKey>
          <namespace>string</namespace>
          <notificationName>string</notificationName>
     </businessObjectDataNotificationRegistrationKey>
     <businessObjectDataEventType>string</businessObjectDataEventType>
     <businessObjectDataNotificationFilter>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <storageName>string</storageName>
          <newBusinessObjectDataStatus>string</newBusinessObjectDataStatus>
          <oldBusinessObjectDataStatus>string</oldBusinessObjectDataStatus>
     </businessObjectDataNotificationFilter>
     <jobActions>
          <jobAction>
               <namespace>string</namespace>
               <jobName>string</jobName>
               <correlationData>
        <![CDATA[
        string]]>
      </correlationData>
          </jobAction>
     </jobActions>
     <notificationRegistrationStatus>string</notificationRegistrationStatus>
</businessObjectDataNotificationRegistration>

Response Content Type

get /notificationRegistrations/businessObjectDataNotificationRegistrations/namespaces/{namespace}

getBusinessObjectDataNotificationRegistrationsByNamespace

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace of the business object data notification registration	path	string

delete /notificationRegistrations/businessObjectDataNotificationRegistrations/namespaces/{namespace}/notificationNames/{notificationName}

deleteBusinessObjectDataNotification

Implementation Notes

Deletes an existing business object data notification by key.

Requires WRITE permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace	path	string
notificationName		the business object data notification name	path	string

Response (Status 200)

businessObjectDataNotificationRegistration {

id (integer, optional):

A system unique ID of this registration

,

businessObjectDataNotificationRegistrationKey (notificationRegistrationKey):

A unique identifier for a business object data notification registration

,

businessObjectDataEventType (string):

The type of business object data event in which this notification should trigger

,

businessObjectDataNotificationFilter (businessObjectDataNotificationFilter):

The filter to use against business object data events

,

jobActions (Array[jobAction], optional):

The list of jobs to execute when this notification is triggered

,

notificationRegistrationStatus (string):

The status of the notification registration

}
notificationRegistrationKey {

namespace (string),

notificationName (string)

}
businessObjectDataNotificationFilter {

namespace (string):

The namespace of the business object definition

,

businessObjectDefinitionName (string):

The business object definition name

,

businessObjectFormatUsage (string, optional):

The business object format usage

,

businessObjectFormatFileType (string, optional):

The business object format file type

,

businessObjectFormatVersion (integer, optional):

The business object format version

,

storageName (string, optional):

The storage name

,

newBusinessObjectDataStatus (string, optional):

The new business object data status

,

oldBusinessObjectDataStatus (string, optional):

The old business object data status

}
jobAction {

namespace (string):

The namespace

,

jobName (string):

The job name

,

correlationData (string, optional):

The correlation data

}

{
  "id": 0,
  "businessObjectDataNotificationRegistrationKey": {
    "namespace": "string",
    "notificationName": "string"
  },
  "businessObjectDataEventType": "string",
  "businessObjectDataNotificationFilter": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "storageName": "string",
    "newBusinessObjectDataStatus": "string",
    "oldBusinessObjectDataStatus": "string"
  },
  "jobActions": [
    {
      "namespace": "string",
      "jobName": "string",
      "correlationData": "string"
    }
  ],
  "notificationRegistrationStatus": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataNotificationRegistration>
     <id>0</id>
     <businessObjectDataNotificationRegistrationKey>
          <namespace>string</namespace>
          <notificationName>string</notificationName>
     </businessObjectDataNotificationRegistrationKey>
     <businessObjectDataEventType>string</businessObjectDataEventType>
     <businessObjectDataNotificationFilter>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <storageName>string</storageName>
          <newBusinessObjectDataStatus>string</newBusinessObjectDataStatus>
          <oldBusinessObjectDataStatus>string</oldBusinessObjectDataStatus>
     </businessObjectDataNotificationFilter>
     <jobActions>
          <jobAction>
               <namespace>string</namespace>
               <jobName>string</jobName>
               <correlationData>
        <![CDATA[
        string]]>
      </correlationData>
          </jobAction>
     </jobActions>
     <notificationRegistrationStatus>string</notificationRegistrationStatus>
</businessObjectDataNotificationRegistration>

Response Content Type

get /notificationRegistrations/businessObjectDataNotificationRegistrations/namespaces/{namespace}/notificationNames/{notificationName}

getBusinessObjectDataNotificationRegistration

Implementation Notes

Gets an existing business object data notification by key.

Requires READ permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace	path	string
notificationName		the business object data notification name	path	string

Response (Status 200)

businessObjectDataNotificationRegistration {

id (integer, optional):

A system unique ID of this registration

,

businessObjectDataNotificationRegistrationKey (notificationRegistrationKey):

A unique identifier for a business object data notification registration

,

businessObjectDataEventType (string):

The type of business object data event in which this notification should trigger

,

businessObjectDataNotificationFilter (businessObjectDataNotificationFilter):

The filter to use against business object data events

,

jobActions (Array[jobAction], optional):

The list of jobs to execute when this notification is triggered

,

notificationRegistrationStatus (string):

The status of the notification registration

}
notificationRegistrationKey {

namespace (string),

notificationName (string)

}
businessObjectDataNotificationFilter {

namespace (string):

The namespace of the business object definition

,

businessObjectDefinitionName (string):

The business object definition name

,

businessObjectFormatUsage (string, optional):

The business object format usage

,

businessObjectFormatFileType (string, optional):

The business object format file type

,

businessObjectFormatVersion (integer, optional):

The business object format version

,

storageName (string, optional):

The storage name

,

newBusinessObjectDataStatus (string, optional):

The new business object data status

,

oldBusinessObjectDataStatus (string, optional):

The old business object data status

}
jobAction {

namespace (string):

The namespace

,

jobName (string):

The job name

,

correlationData (string, optional):

The correlation data

}

{
  "id": 0,
  "businessObjectDataNotificationRegistrationKey": {
    "namespace": "string",
    "notificationName": "string"
  },
  "businessObjectDataEventType": "string",
  "businessObjectDataNotificationFilter": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "storageName": "string",
    "newBusinessObjectDataStatus": "string",
    "oldBusinessObjectDataStatus": "string"
  },
  "jobActions": [
    {
      "namespace": "string",
      "jobName": "string",
      "correlationData": "string"
    }
  ],
  "notificationRegistrationStatus": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataNotificationRegistration>
     <id>0</id>
     <businessObjectDataNotificationRegistrationKey>
          <namespace>string</namespace>
          <notificationName>string</notificationName>
     </businessObjectDataNotificationRegistrationKey>
     <businessObjectDataEventType>string</businessObjectDataEventType>
     <businessObjectDataNotificationFilter>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <storageName>string</storageName>
          <newBusinessObjectDataStatus>string</newBusinessObjectDataStatus>
          <oldBusinessObjectDataStatus>string</oldBusinessObjectDataStatus>
     </businessObjectDataNotificationFilter>
     <jobActions>
          <jobAction>
               <namespace>string</namespace>
               <jobName>string</jobName>
               <correlationData>
        <![CDATA[
        string]]>
      </correlationData>
          </jobAction>
     </jobActions>
     <notificationRegistrationStatus>string</notificationRegistrationStatus>
</businessObjectDataNotificationRegistration>

Response Content Type

put /notificationRegistrations/businessObjectDataNotificationRegistrations/namespaces/{namespace}/notificationNames/{notificationName}

updateBusinessObjectDataNotificationRegistration

Implementation Notes

Updates an existing business object data notification by key.

Requires WRITE permission on namespace

Requires READ permission on filter namespace

Requires EXECUTE permission on ALL job action namespaces

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace	path	string
notificationName		the business object data notification name	path	string
businessObjectDataNotificationRegistrationUpdateRequest: the information needed to update the business object data notification	Parameter content type: Model JSON Schema XML Example businessObjectDataNotificationRegistrationUpdateRequest { businessObjectDataEventType (string): The type of business object data event in which this notification should trigger , businessObjectDataNotificationFilter (businessObjectDataNotificationFilter): The filter to use against business object data events. The notification will only trigger for events matching this filter. , jobActions (Array[jobAction], optional): The list of jobs to execute when this notification is triggered , notificationRegistrationStatus (string): The status of the notification registration } businessObjectDataNotificationFilter { namespace (string): The namespace of the business object definition , businessObjectDefinitionName (string): The business object definition name , businessObjectFormatUsage (string, optional): The business object format usage , businessObjectFormatFileType (string, optional): The business object format file type , businessObjectFormatVersion (integer, optional): The business object format version , storageName (string, optional): The storage name , newBusinessObjectDataStatus (string, optional): The new business object data status , oldBusinessObjectDataStatus (string, optional): The old business object data status } jobAction { namespace (string): The namespace , jobName (string): The job name , correlationData (string, optional): The correlation data } { "businessObjectDataEventType": "string", "businessObjectDataNotificationFilter": { "namespace": "string", "businessObjectDefinitionName": "string", "businessObjectFormatUsage": "string", "businessObjectFormatFileType": "string", "businessObjectFormatVersion": 0, "storageName": "string", "newBusinessObjectDataStatus": "string", "oldBusinessObjectDataStatus": "string" }, "jobActions": [ { "namespace": "string", "jobName": "string", "correlationData": "string" } ], "notificationRegistrationStatus": "string" } Click to set as parameter value <?xml version="1.0" encoding="UTF-8"?> <businessObjectDataNotificationRegistrationUpdateRequest> <businessObjectDataEventType>string</businessObjectDataEventType> <businessObjectDataNotificationFilter> <namespace>string</namespace> <businessObjectDefinitionName>string</businessObjectDefinitionName> <businessObjectFormatUsage>string</businessObjectFormatUsage> <businessObjectFormatFileType>string</businessObjectFormatFileType> <businessObjectFormatVersion>0</businessObjectFormatVersion> <storageName>string</storageName> <newBusinessObjectDataStatus>string</newBusinessObjectDataStatus> <oldBusinessObjectDataStatus>string</oldBusinessObjectDataStatus> </businessObjectDataNotificationFilter> <jobActions> <jobAction> <namespace>string</namespace> <jobName>string</jobName> <correlationData> <![CDATA[ string]]> </correlationData> </jobAction> </jobActions> <notificationRegistrationStatus>string</notificationRegistrationStatus> </businessObjectDataNotificationRegistrationUpdateRequest> Click to set as parameter value

Response (Status 200)

businessObjectDataNotificationRegistration {

id (integer, optional):

A system unique ID of this registration

,

businessObjectDataNotificationRegistrationKey (notificationRegistrationKey):

A unique identifier for a business object data notification registration

,

businessObjectDataEventType (string):

The type of business object data event in which this notification should trigger

,

businessObjectDataNotificationFilter (businessObjectDataNotificationFilter):

The filter to use against business object data events

,

jobActions (Array[jobAction], optional):

The list of jobs to execute when this notification is triggered

,

notificationRegistrationStatus (string):

The status of the notification registration

}
notificationRegistrationKey {

namespace (string),

notificationName (string)

}
businessObjectDataNotificationFilter {

namespace (string):

The namespace of the business object definition

,

businessObjectDefinitionName (string):

The business object definition name

,

businessObjectFormatUsage (string, optional):

The business object format usage

,

businessObjectFormatFileType (string, optional):

The business object format file type

,

businessObjectFormatVersion (integer, optional):

The business object format version

,

storageName (string, optional):

The storage name

,

newBusinessObjectDataStatus (string, optional):

The new business object data status

,

oldBusinessObjectDataStatus (string, optional):

The old business object data status

}
jobAction {

namespace (string):

The namespace

,

jobName (string):

The job name

,

correlationData (string, optional):

The correlation data

}

{
  "id": 0,
  "businessObjectDataNotificationRegistrationKey": {
    "namespace": "string",
    "notificationName": "string"
  },
  "businessObjectDataEventType": "string",
  "businessObjectDataNotificationFilter": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "storageName": "string",
    "newBusinessObjectDataStatus": "string",
    "oldBusinessObjectDataStatus": "string"
  },
  "jobActions": [
    {
      "namespace": "string",
      "jobName": "string",
      "correlationData": "string"
    }
  ],
  "notificationRegistrationStatus": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataNotificationRegistration>
     <id>0</id>
     <businessObjectDataNotificationRegistrationKey>
          <namespace>string</namespace>
          <notificationName>string</notificationName>
     </businessObjectDataNotificationRegistrationKey>
     <businessObjectDataEventType>string</businessObjectDataEventType>
     <businessObjectDataNotificationFilter>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <storageName>string</storageName>
          <newBusinessObjectDataStatus>string</newBusinessObjectDataStatus>
          <oldBusinessObjectDataStatus>string</oldBusinessObjectDataStatus>
     </businessObjectDataNotificationFilter>
     <jobActions>
          <jobAction>
               <namespace>string</namespace>
               <jobName>string</jobName>
               <correlationData>
        <![CDATA[
        string]]>
      </correlationData>
          </jobAction>
     </jobActions>
     <notificationRegistrationStatus>string</notificationRegistrationStatus>
</businessObjectDataNotificationRegistration>

Response Content Type

Business Object Data Status

get /businessObjectDataStatus/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}

getBusinessObjectDataStatus

Implementation Notes

Retrieves status information for an existing business object data.

Requires READ permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
partitionKey	the business object format partition key.	query	string
partitionValue	the partition value	query	string
subPartitionValues	the list of sub-partition values	query	string
businessObjectFormatVersion	the business object format version	query	integer
businessObjectDataVersion	the business object data version	query	integer

Response (Status 200)

businessObjectDataStatusInformation {

businessObjectDataKey (businessObjectDataKey):

Values that uniquely identify a Business Object Data

,

status (string):

The status of the Business Object Data. One of the following values: UPLOADING,VALID, INVALID, ARCHIVED, EXPIRED

}
businessObjectDataKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values this Business Object Data is associated with

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

}

{
  "businessObjectDataKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "partitionValue": "string",
    "subPartitionValues": [
      "string"
    ],
    "businessObjectDataVersion": 0
  },
  "status": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataStatusInformation>
     <businessObjectDataKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
     </businessObjectDataKey>
     <status>string</status>
</businessObjectDataStatusInformation>

Response Content Type

put /businessObjectDataStatus/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/businessObjectDataVersions/{businessObjectDataVersion}

updateBusinessObjectDataStatus

Implementation Notes

Updates status of a business object data without subpartition values.

Requires WRITE permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace	path	string
businessObjectDefinitionName		the business object definition name	path	string
businessObjectFormatUsage		the business object format usage	path	string
businessObjectFormatFileType		the business object format file type	path	string
businessObjectFormatVersion		the business object format version	path	integer
partitionValue		the partition value	path	string
businessObjectDataVersion		the business object data version	path	integer
businessObjectDataStatusUpdateRequest: the business object data status update request	Parameter content type: Model JSON Schema XML Example businessObjectDataStatusUpdateRequest { status (string, optional): The status of the Business Object Data. One of the following values: UPLOADING,VALID, INVALID, ARCHIVED, EXPIRED } `{ "status": "string" }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <businessObjectDataStatusUpdateRequest> <status>string</status> </businessObjectDataStatusUpdateRequest>` Click to set as parameter value

Response (Status 200)

businessObjectDataStatusUpdateResponse {

businessObjectDataKey (businessObjectDataKey):

Values that uniquely identify a Business Object Data

,

status (string):

The status of the Business Object Data. One of the following values: UPLOADING,VALID, INVALID, ARCHIVED, EXPIRED

,

previousStatus (string):

The status of the Business Object Data prior to the update

}
businessObjectDataKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values this Business Object Data is associated with

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

}

{
  "businessObjectDataKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "partitionValue": "string",
    "subPartitionValues": [
      "string"
    ],
    "businessObjectDataVersion": 0
  },
  "status": "string",
  "previousStatus": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataStatusUpdateResponse>
     <businessObjectDataKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
     </businessObjectDataKey>
     <status>string</status>
     <previousStatus>string</previousStatus>
</businessObjectDataStatusUpdateResponse>

Response Content Type

put /businessObjectDataStatus/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/businessObjectDataVersions/{businessObjectDataVersion}

updateBusinessObjectDataStatus

Implementation Notes

Updates status of a business object data with 1 subpartition values.

Requires WRITE permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace	path	string
businessObjectDefinitionName		the business object definition name	path	string
businessObjectFormatUsage		the business object format usage	path	string
businessObjectFormatFileType		the business object format file type	path	string
businessObjectFormatVersion		the business object format version	path	integer
partitionValue		the partition value	path	string
subPartition1Value		the value of the first subpartition	path	string
businessObjectDataVersion		the business object data version	path	integer
businessObjectDataStatusUpdateRequest: the business object data status update request	Parameter content type: Model JSON Schema XML Example businessObjectDataStatusUpdateRequest { status (string, optional): The status of the Business Object Data. One of the following values: UPLOADING,VALID, INVALID, ARCHIVED, EXPIRED } `{ "status": "string" }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <businessObjectDataStatusUpdateRequest> <status>string</status> </businessObjectDataStatusUpdateRequest>` Click to set as parameter value

Response (Status 200)

businessObjectDataStatusUpdateResponse {

businessObjectDataKey (businessObjectDataKey):

Values that uniquely identify a Business Object Data

,

status (string):

The status of the Business Object Data. One of the following values: UPLOADING,VALID, INVALID, ARCHIVED, EXPIRED

,

previousStatus (string):

The status of the Business Object Data prior to the update

}
businessObjectDataKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values this Business Object Data is associated with

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

}

{
  "businessObjectDataKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "partitionValue": "string",
    "subPartitionValues": [
      "string"
    ],
    "businessObjectDataVersion": 0
  },
  "status": "string",
  "previousStatus": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataStatusUpdateResponse>
     <businessObjectDataKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
     </businessObjectDataKey>
     <status>string</status>
     <previousStatus>string</previousStatus>
</businessObjectDataStatusUpdateResponse>

Response Content Type

put /businessObjectDataStatus/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/subPartition2Values/{subPartition2Value}/businessObjectDataVersions/{businessObjectDataVersion}

updateBusinessObjectDataStatus

Implementation Notes

Updates status of a business object data with 2 subpartition values.

Requires WRITE permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace	path	string
businessObjectDefinitionName		the business object definition name	path	string
businessObjectFormatUsage		the business object format usage	path	string
businessObjectFormatFileType		the business object format file type	path	string
businessObjectFormatVersion		the business object format version	path	integer
partitionValue		the partition value	path	string
subPartition1Value		the value of the first subpartition	path	string
subPartition2Value		the value of the second subpartition	path	string
businessObjectDataVersion		the business object data version	path	integer
businessObjectDataStatusUpdateRequest: the business object data status update request	Parameter content type: Model JSON Schema XML Example businessObjectDataStatusUpdateRequest { status (string, optional): The status of the Business Object Data. One of the following values: UPLOADING,VALID, INVALID, ARCHIVED, EXPIRED } `{ "status": "string" }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <businessObjectDataStatusUpdateRequest> <status>string</status> </businessObjectDataStatusUpdateRequest>` Click to set as parameter value

Response (Status 200)

businessObjectDataStatusUpdateResponse {

businessObjectDataKey (businessObjectDataKey):

Values that uniquely identify a Business Object Data

,

status (string):

The status of the Business Object Data. One of the following values: UPLOADING,VALID, INVALID, ARCHIVED, EXPIRED

,

previousStatus (string):

The status of the Business Object Data prior to the update

}
businessObjectDataKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values this Business Object Data is associated with

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

}

{
  "businessObjectDataKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "partitionValue": "string",
    "subPartitionValues": [
      "string"
    ],
    "businessObjectDataVersion": 0
  },
  "status": "string",
  "previousStatus": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataStatusUpdateResponse>
     <businessObjectDataKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
     </businessObjectDataKey>
     <status>string</status>
     <previousStatus>string</previousStatus>
</businessObjectDataStatusUpdateResponse>

Response Content Type

put /businessObjectDataStatus/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/subPartition2Values/{subPartition2Value}/subPartition3Values/{subPartition3Value}/businessObjectDataVersions/{businessObjectDataVersion}

updateBusinessObjectDataStatus

Implementation Notes

Updates status of a business object data with 3 subpartition values.

Requires WRITE permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace	path	string
businessObjectDefinitionName		the business object definition name	path	string
businessObjectFormatUsage		the business object format usage	path	string
businessObjectFormatFileType		the business object format file type	path	string
businessObjectFormatVersion		the business object format version	path	integer
partitionValue		the partition value	path	string
subPartition1Value		the value of the first subpartition	path	string
subPartition2Value		the value of the second subpartition	path	string
subPartition3Value		the value of the third subpartition	path	string
businessObjectDataVersion		the business object data version	path	integer
businessObjectDataStatusUpdateRequest: the business object data status update request	Parameter content type: Model JSON Schema XML Example businessObjectDataStatusUpdateRequest { status (string, optional): The status of the Business Object Data. One of the following values: UPLOADING,VALID, INVALID, ARCHIVED, EXPIRED } `{ "status": "string" }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <businessObjectDataStatusUpdateRequest> <status>string</status> </businessObjectDataStatusUpdateRequest>` Click to set as parameter value

Response (Status 200)

businessObjectDataStatusUpdateResponse {

businessObjectDataKey (businessObjectDataKey):

Values that uniquely identify a Business Object Data

,

status (string):

The status of the Business Object Data. One of the following values: UPLOADING,VALID, INVALID, ARCHIVED, EXPIRED

,

previousStatus (string):

The status of the Business Object Data prior to the update

}
businessObjectDataKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values this Business Object Data is associated with

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

}

{
  "businessObjectDataKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "partitionValue": "string",
    "subPartitionValues": [
      "string"
    ],
    "businessObjectDataVersion": 0
  },
  "status": "string",
  "previousStatus": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataStatusUpdateResponse>
     <businessObjectDataKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
     </businessObjectDataKey>
     <status>string</status>
     <previousStatus>string</previousStatus>
</businessObjectDataStatusUpdateResponse>

Response Content Type

put /businessObjectDataStatus/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/subPartition1Values/{subPartition1Value}/subPartition2Values/{subPartition2Value}/subPartition3Values/{subPartition3Value}/subPartition4Values/{subPartition4Value}/businessObjectDataVersions/{businessObjectDataVersion}

updateBusinessObjectDataStatus

Implementation Notes

Updates status of a business object data with 4 subpartition values.

Requires WRITE permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace	path	string
businessObjectDefinitionName		the business object definition name	path	string
businessObjectFormatUsage		the business object format usage	path	string
businessObjectFormatFileType		the business object format file type	path	string
businessObjectFormatVersion		the business object format version	path	integer
partitionValue		the partition value	path	string
subPartition1Value		the value of the first subpartition	path	string
subPartition2Value		the value of the second subpartition	path	string
subPartition3Value		the value of the third subpartition	path	string
subPartition4Value		the value of the forth subpartition	path	string
businessObjectDataVersion		the business object data version	path	integer
businessObjectDataStatusUpdateRequest: the business object data status update request	Parameter content type: Model JSON Schema XML Example businessObjectDataStatusUpdateRequest { status (string, optional): The status of the Business Object Data. One of the following values: UPLOADING,VALID, INVALID, ARCHIVED, EXPIRED } `{ "status": "string" }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <businessObjectDataStatusUpdateRequest> <status>string</status> </businessObjectDataStatusUpdateRequest>` Click to set as parameter value

Response (Status 200)

businessObjectDataStatusUpdateResponse {

businessObjectDataKey (businessObjectDataKey):

Values that uniquely identify a Business Object Data

,

status (string):

The status of the Business Object Data. One of the following values: UPLOADING,VALID, INVALID, ARCHIVED, EXPIRED

,

previousStatus (string):

The status of the Business Object Data prior to the update

}
businessObjectDataKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values this Business Object Data is associated with

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

}

{
  "businessObjectDataKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "partitionValue": "string",
    "subPartitionValues": [
      "string"
    ],
    "businessObjectDataVersion": 0
  },
  "status": "string",
  "previousStatus": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataStatusUpdateResponse>
     <businessObjectDataKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <businessObjectDataVersion>0</businessObjectDataVersion>
     </businessObjectDataKey>
     <status>string</status>
     <previousStatus>string</previousStatus>
</businessObjectDataStatusUpdateResponse>

Response Content Type

Business Object Data Storage File

post /businessObjectDataStorageFiles

createBusinessObjectDataStorageFiles

Implementation Notes

Creates new file(s) for a given business object data and storage.

Addition of storage files is only allowed for business object data with a pre-registration status.

Requires WRITE permission on namespace

Parameter (body): - the create file request

Parameter content type:

businessObjectDataStorageFilesCreateRequest {

namespace (string):

The namespace of the business object data

,

businessObjectDefinitionName (string):

The definition name of the business object data

,

businessObjectFormatUsage (string):

The format usage of the business object data

,

businessObjectFormatFileType (string):

The format file type of the business object data

,

businessObjectFormatVersion (integer, optional):

The format version of the business object data

,

partitionValue (string):

The the primary partition value of the business object data

,

subPartitionValues (Array[string], optional):

The subpartition values of the business object data

,

businessObjectDataVersion (integer, optional):

The version of the business object data

,

storageName (string):

The name of the storage

,

storageFiles (Array[storageFile], optional):

              The list of storage files to be added. Storage files are required, unless discovery of storage files is enabled. In that case, the storage
              files are not allowed to be specified

,

discoverStorageFiles (boolean, optional):

              If true, enables the auto-discovery of all storage files in the relative S3 storage under the relative storage directory

}
storageFile {

filePath (string):

The fully qualified file path to the data. When Storage Directory is specified, all Storage File paths should start with the Storage Directory path

,

fileSizeBytes (integer, optional):

The file size in bytes

,

rowCount (integer, optional):

The number of lines in the file

}

{
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "businessObjectFormatUsage": "string",
  "businessObjectFormatFileType": "string",
  "businessObjectFormatVersion": 0,
  "partitionValue": "string",
  "subPartitionValues": [
    "string"
  ],
  "businessObjectDataVersion": 0,
  "storageName": "string",
  "storageFiles": [
    {
      "filePath": "string",
      "fileSizeBytes": 0,
      "rowCount": 0
    }
  ],
  "discoverStorageFiles": true
}

Click to set as parameter value

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataStorageFilesCreateRequest>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <businessObjectFormatUsage>string</businessObjectFormatUsage>
     <businessObjectFormatFileType>string</businessObjectFormatFileType>
     <businessObjectFormatVersion>0</businessObjectFormatVersion>
     <partitionValue>string</partitionValue>
     <subPartitionValues>
          <partitionValue>string</partitionValue>
     </subPartitionValues>
     <businessObjectDataVersion>0</businessObjectDataVersion>
     <storageName>string</storageName>
     <storageFiles>
          <storageFile>
               <filePath>string</filePath>
               <fileSizeBytes>0</fileSizeBytes>
               <rowCount>0</rowCount>
          </storageFile>
     </storageFiles>
     <discoverStorageFiles>true</discoverStorageFiles>
</businessObjectDataStorageFilesCreateRequest>

Click to set as parameter value

Response (Status 200)

businessObjectDataStorageFilesCreateResponse {

namespace (string):

The namespace of the business object data

,

businessObjectDefinitionName (string):

The definition name of the business object data

,

businessObjectFormatUsage (string):

The format usage of the business object data

,

businessObjectFormatFileType (string):

The format file type of the business object data

,

businessObjectFormatVersion (integer, optional):

The format version of the business object data

,

partitionValue (string):

The the primary partition value of the business object data

,

subPartitionValues (Array[string], optional):

The subpartition values of the business object data

,

businessObjectDataVersion (integer, optional):

The version of the business object data

,

storageName (string):

The name of the storage

,

storageFiles (Array[storageFile], optional):

The list of storage files

}
storageFile {

filePath (string):

The fully qualified file path to the data. When Storage Directory is specified, all Storage File paths should start with the Storage Directory path

,

fileSizeBytes (integer, optional):

The file size in bytes

,

rowCount (integer, optional):

The number of lines in the file

}

{
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "businessObjectFormatUsage": "string",
  "businessObjectFormatFileType": "string",
  "businessObjectFormatVersion": 0,
  "partitionValue": "string",
  "subPartitionValues": [
    "string"
  ],
  "businessObjectDataVersion": 0,
  "storageName": "string",
  "storageFiles": [
    {
      "filePath": "string",
      "fileSizeBytes": 0,
      "rowCount": 0
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDataStorageFilesCreateResponse>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <businessObjectFormatUsage>string</businessObjectFormatUsage>
     <businessObjectFormatFileType>string</businessObjectFormatFileType>
     <businessObjectFormatVersion>0</businessObjectFormatVersion>
     <partitionValue>string</partitionValue>
     <subPartitionValues>
          <partitionValue>string</partitionValue>
     </subPartitionValues>
     <businessObjectDataVersion>0</businessObjectDataVersion>
     <storageName>string</storageName>
     <storageFiles>
          <storageFile>
               <filePath>string</filePath>
               <fileSizeBytes>0</fileSizeBytes>
               <rowCount>0</rowCount>
          </storageFile>
     </storageFiles>
</businessObjectDataStorageFilesCreateResponse>

Response Content Type

Business Object Definition

put /businessObjectDefinitionDescriptiveInformation/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}

updateBusinessObjectDefinitionDescriptiveInformation

Implementation Notes

Updates an existing business object definition descriptive information by key.

Requires no Namespace level security

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace code	path	string
businessObjectDefinitionName		the name of the business object definition to update	path	string
businessObjectDefinitionDescriptiveInformationUpdateRequest: the information needed to update the business object definition	Parameter content type: Model JSON Schema XML Example businessObjectDefinitionDescriptiveInformationUpdateRequest { description (string, optional): An optional description , displayName (string, optional): An optional business friendly name for business object definition , descriptiveBusinessObjectFormat (descriptiveBusinessObjectFormatUpdateRequest, optional): An optional business object definition descriptive format update request } descriptiveBusinessObjectFormatUpdateRequest { businessObjectFormatUsage (string): The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. , businessObjectFormatFileType (string): The File type for this Business Object Definition } `{ "description": "string", "displayName": "string", "descriptiveBusinessObjectFormat": { "businessObjectFormatUsage": "string", "businessObjectFormatFileType": "string" } }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <businessObjectDefinitionDescriptiveInformationUpdateRequest> <description>string</description> <displayName>string</displayName> <descriptiveBusinessObjectFormat> <businessObjectFormatUsage>string</businessObjectFormatUsage> <businessObjectFormatFileType>string</businessObjectFormatFileType> </descriptiveBusinessObjectFormat> </businessObjectDefinitionDescriptiveInformationUpdateRequest>` Click to set as parameter value

Response (Status 200)

businessObjectDefinition {

id (integer, optional):

The internal identifier that uniquely references a Business Object Definition

,

namespace (string):

The name of a valid Namespace known by the system

,

businessObjectDefinitionName (string):

The name for this Business Object Definition

,

dataProviderName (string, optional):

The name of a valid Data Provider known by the system

,

description (string, optional):

An optional description

,

shortDescription (string, optional):

              An optional short-description. This is actually the 'description' field truncated to a configurable number of characters.

,

displayName (string, optional):

An optional business friendly name

,

attributes (Array[attribute], optional):

Custom user-defined metadata associated with this Business Object Definition. "name" is the attribute name (i.e. the key) and "value" is the attribute value

,

descriptiveBusinessObjectFormat (descriptiveBusinessObjectFormat, optional):

An optional business object definition descriptive format. The descriptive format is the single Business Object Format that will be used to represent this Business Object Definition to consumers

,

sampleDataFiles (Array[sampleDataFile], optional):

              An optional list of sample data files associated with the Business Object Definition

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}
descriptiveBusinessObjectFormat {

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format

,

businessObjectFormatFileType (string):

The File type for this Business Object Format

,

businessObjectFormatVersion (integer, optional):

The numeric version of a Business Object Format. Each time a format is registered, the new version will be the previous version

+ 1

}
sampleDataFile {

directoryPath (string):

The directory path of the sample data file. Note that directory path will contain a trailing "directory" separator, thus the caller needs to concatenate the directory path and the file name as is in order to construct a fully qualified path for the sample data file

,

fileName (string):

The name of the sample data file

}

{
  "id": 0,
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "dataProviderName": "string",
  "description": "string",
  "shortDescription": "string",
  "displayName": "string",
  "attributes": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "descriptiveBusinessObjectFormat": {
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0
  },
  "sampleDataFiles": [
    {
      "directoryPath": "string",
      "fileName": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDefinition>
     <id>0</id>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <dataProviderName>string</dataProviderName>
     <description>string</description>
     <shortDescription>string</shortDescription>
     <displayName>string</displayName>
     <attributes>
          <attribute>
               <name>string</name>
               <value>string</value>
          </attribute>
     </attributes>
     <descriptiveBusinessObjectFormat>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
     </descriptiveBusinessObjectFormat>
     <sampleDataFiles>
          <sampleDataFile>
               <directoryPath>string</directoryPath>
               <fileName>string</fileName>
          </sampleDataFile>
     </sampleDataFiles>
</businessObjectDefinition>

Response Content Type

- get /businessObjectDefinitions
  - getBusinessObjectDefinitions
  Implementation Notes
  
  Gets the list of business object definitions that are defined in the system.
  Response (Status 200)
  Model
  
  JSON Schema
  
  XML Example
  
  businessObjectDefinitionKeys {
  businessObjectDefinitionKeys (Array[businessObjectDefinitionKey], optional)
  }
  businessObjectDefinitionKey {
  namespace (string):
  The name of a valid Namespace known by the system
  ,
  businessObjectDefinitionName (string):
  The name for this Business Object Definition
  
  }
  
  { "businessObjectDefinitionKeys": [ { "namespace": "string", "businessObjectDefinitionName": "string" } ] }
  
  <?xml version="1.0" encoding="UTF-8"?> <businessObjectDefinitionKeys> <businessObjectDefinitionKey> <namespace>string</namespace> <businessObjectDefinitionName>string</businessObjectDefinitionName> </businessObjectDefinitionKey> </businessObjectDefinitionKeys>
  Response Content Type
  
  Hide Response
  Curl
  
  Request URL
  
  Response Body
  
  Response Code

post /businessObjectDefinitions

createBusinessObjectDefinition

Implementation Notes

Creates a new business object definition.

Requires WRITE permission on namespace

Parameter (body): the information needed to create the business object definition.
Parameter content type: Model JSON Schema XML Example businessObjectDefinitionCreateRequest { namespace (string): The name of a valid Namespace known by the system , businessObjectDefinitionName (string): The name for this Business Object Definition , dataProviderName (string): The name of a valid Data Provider known by the system , description (string, optional): An optional description , displayName (string, optional): An optional business friendly name , attributes (Array[attribute], optional): Custom user-defined metadata associated with this Business Object Definition. "name" is the attribute name (i.e. the key) and "value" is the attribute value. } attribute { name (string): Attribute key , value (string, optional): Attribute value } `{ "namespace": "string", "businessObjectDefinitionName": "string", "dataProviderName": "string", "description": "string", "displayName": "string", "attributes": [ { "name": "string", "value": "string" } ] }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <businessObjectDefinitionCreateRequest> <namespace>string</namespace> <businessObjectDefinitionName>string</businessObjectDefinitionName> <dataProviderName>string</dataProviderName> <description>string</description> <displayName>string</displayName> <attributes> <attribute> <name>string</name> <value>string</value> </attribute> </attributes> </businessObjectDefinitionCreateRequest>` Click to set as parameter value

Response (Status 200)

businessObjectDefinition {

id (integer, optional):

The internal identifier that uniquely references a Business Object Definition

,

namespace (string):

The name of a valid Namespace known by the system

,

businessObjectDefinitionName (string):

The name for this Business Object Definition

,

dataProviderName (string, optional):

The name of a valid Data Provider known by the system

,

description (string, optional):

An optional description

,

shortDescription (string, optional):

              An optional short-description. This is actually the 'description' field truncated to a configurable number of characters.

,

displayName (string, optional):

An optional business friendly name

,

attributes (Array[attribute], optional):

Custom user-defined metadata associated with this Business Object Definition. "name" is the attribute name (i.e. the key) and "value" is the attribute value

,

descriptiveBusinessObjectFormat (descriptiveBusinessObjectFormat, optional):

An optional business object definition descriptive format. The descriptive format is the single Business Object Format that will be used to represent this Business Object Definition to consumers

,

sampleDataFiles (Array[sampleDataFile], optional):

              An optional list of sample data files associated with the Business Object Definition

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}
descriptiveBusinessObjectFormat {

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format

,

businessObjectFormatFileType (string):

The File type for this Business Object Format

,

businessObjectFormatVersion (integer, optional):

The numeric version of a Business Object Format. Each time a format is registered, the new version will be the previous version

+ 1

}
sampleDataFile {

directoryPath (string):

The directory path of the sample data file. Note that directory path will contain a trailing "directory" separator, thus the caller needs to concatenate the directory path and the file name as is in order to construct a fully qualified path for the sample data file

,

fileName (string):

The name of the sample data file

}

{
  "id": 0,
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "dataProviderName": "string",
  "description": "string",
  "shortDescription": "string",
  "displayName": "string",
  "attributes": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "descriptiveBusinessObjectFormat": {
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0
  },
  "sampleDataFiles": [
    {
      "directoryPath": "string",
      "fileName": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDefinition>
     <id>0</id>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <dataProviderName>string</dataProviderName>
     <description>string</description>
     <shortDescription>string</shortDescription>
     <displayName>string</displayName>
     <attributes>
          <attribute>
               <name>string</name>
               <value>string</value>
          </attribute>
     </attributes>
     <descriptiveBusinessObjectFormat>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
     </descriptiveBusinessObjectFormat>
     <sampleDataFiles>
          <sampleDataFile>
               <directoryPath>string</directoryPath>
               <fileName>string</fileName>
          </sampleDataFile>
     </sampleDataFiles>
</businessObjectDefinition>

Response Content Type

- get /businessObjectDefinitions/index
  - indexBusinessObjectDefinitions
  Implementation Notes
  
  Index all business object definitions
  Response (Status 200)
  Model
  
  JSON Schema
  
  XML Example
  
  businessObjectDefinitionIndexResponse {
  indexStartTime (string, optional):
  The timestamp of when the index creation started
  
  }
  
  { "indexStartTime": "2017-04-29T14:40:26.812Z" }
  
  <?xml version="1.0" encoding="UTF-8"?> <businessObjectDefinitionIndexResponse> <indexStartTime>2015-12-25T00:00:00.000-05:00</indexStartTime> </businessObjectDefinitionIndexResponse>
  Response Content Type
  
  Hide Response
  Curl
  
  Request URL
  
  Response Body
  
  Response Code

get /businessObjectDefinitions/namespaces/{namespace}

getBusinessObjectDefinitions

delete /businessObjectDefinitions/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}

deleteBusinessObjectDefinition

Implementation Notes

Deletes an existing business object definition by key.

Requires WRITE permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace code	path	string
businessObjectDefinitionName		the business object definition name	path	string

Response (Status 200)

businessObjectDefinition {

id (integer, optional):

The internal identifier that uniquely references a Business Object Definition

,

namespace (string):

The name of a valid Namespace known by the system

,

businessObjectDefinitionName (string):

The name for this Business Object Definition

,

dataProviderName (string, optional):

The name of a valid Data Provider known by the system

,

description (string, optional):

An optional description

,

shortDescription (string, optional):

              An optional short-description. This is actually the 'description' field truncated to a configurable number of characters.

,

displayName (string, optional):

An optional business friendly name

,

attributes (Array[attribute], optional):

Custom user-defined metadata associated with this Business Object Definition. "name" is the attribute name (i.e. the key) and "value" is the attribute value

,

descriptiveBusinessObjectFormat (descriptiveBusinessObjectFormat, optional):

An optional business object definition descriptive format. The descriptive format is the single Business Object Format that will be used to represent this Business Object Definition to consumers

,

sampleDataFiles (Array[sampleDataFile], optional):

              An optional list of sample data files associated with the Business Object Definition

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}
descriptiveBusinessObjectFormat {

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format

,

businessObjectFormatFileType (string):

The File type for this Business Object Format

,

businessObjectFormatVersion (integer, optional):

The numeric version of a Business Object Format. Each time a format is registered, the new version will be the previous version

+ 1

}
sampleDataFile {

directoryPath (string):

The directory path of the sample data file. Note that directory path will contain a trailing "directory" separator, thus the caller needs to concatenate the directory path and the file name as is in order to construct a fully qualified path for the sample data file

,

fileName (string):

The name of the sample data file

}

{
  "id": 0,
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "dataProviderName": "string",
  "description": "string",
  "shortDescription": "string",
  "displayName": "string",
  "attributes": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "descriptiveBusinessObjectFormat": {
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0
  },
  "sampleDataFiles": [
    {
      "directoryPath": "string",
      "fileName": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDefinition>
     <id>0</id>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <dataProviderName>string</dataProviderName>
     <description>string</description>
     <shortDescription>string</shortDescription>
     <displayName>string</displayName>
     <attributes>
          <attribute>
               <name>string</name>
               <value>string</value>
          </attribute>
     </attributes>
     <descriptiveBusinessObjectFormat>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
     </descriptiveBusinessObjectFormat>
     <sampleDataFiles>
          <sampleDataFile>
               <directoryPath>string</directoryPath>
               <fileName>string</fileName>
          </sampleDataFile>
     </sampleDataFiles>
</businessObjectDefinition>

Response Content Type

get /businessObjectDefinitions/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}

getBusinessObjectDefinition

Implementation Notes

Gets an existing business object definition by key.

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace code	path	string
businessObjectDefinitionName		the business object definition name	path	string

Response (Status 200)

businessObjectDefinition {

id (integer, optional):

The internal identifier that uniquely references a Business Object Definition

,

namespace (string):

The name of a valid Namespace known by the system

,

businessObjectDefinitionName (string):

The name for this Business Object Definition

,

dataProviderName (string, optional):

The name of a valid Data Provider known by the system

,

description (string, optional):

An optional description

,

shortDescription (string, optional):

              An optional short-description. This is actually the 'description' field truncated to a configurable number of characters.

,

displayName (string, optional):

An optional business friendly name

,

attributes (Array[attribute], optional):

Custom user-defined metadata associated with this Business Object Definition. "name" is the attribute name (i.e. the key) and "value" is the attribute value

,

descriptiveBusinessObjectFormat (descriptiveBusinessObjectFormat, optional):

An optional business object definition descriptive format. The descriptive format is the single Business Object Format that will be used to represent this Business Object Definition to consumers

,

sampleDataFiles (Array[sampleDataFile], optional):

              An optional list of sample data files associated with the Business Object Definition

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}
descriptiveBusinessObjectFormat {

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format

,

businessObjectFormatFileType (string):

The File type for this Business Object Format

,

businessObjectFormatVersion (integer, optional):

The numeric version of a Business Object Format. Each time a format is registered, the new version will be the previous version

+ 1

}
sampleDataFile {

directoryPath (string):

The directory path of the sample data file. Note that directory path will contain a trailing "directory" separator, thus the caller needs to concatenate the directory path and the file name as is in order to construct a fully qualified path for the sample data file

,

fileName (string):

The name of the sample data file

}

{
  "id": 0,
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "dataProviderName": "string",
  "description": "string",
  "shortDescription": "string",
  "displayName": "string",
  "attributes": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "descriptiveBusinessObjectFormat": {
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0
  },
  "sampleDataFiles": [
    {
      "directoryPath": "string",
      "fileName": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDefinition>
     <id>0</id>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <dataProviderName>string</dataProviderName>
     <description>string</description>
     <shortDescription>string</shortDescription>
     <displayName>string</displayName>
     <attributes>
          <attribute>
               <name>string</name>
               <value>string</value>
          </attribute>
     </attributes>
     <descriptiveBusinessObjectFormat>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
     </descriptiveBusinessObjectFormat>
     <sampleDataFiles>
          <sampleDataFile>
               <directoryPath>string</directoryPath>
               <fileName>string</fileName>
          </sampleDataFile>
     </sampleDataFiles>
</businessObjectDefinition>

Response Content Type

put /businessObjectDefinitions/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}

updateBusinessObjectDefinition

Implementation Notes

Updates an existing business object definition by key.

Requires WRITE permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace code	path	string
businessObjectDefinitionName		the name of the business object definition to update	path	string
businessObjectDefinitionUpdateRequest: the information needed to update the business object definition	Parameter content type: Model JSON Schema XML Example businessObjectDefinitionUpdateRequest { description (string, optional): An optional description , displayName (string, optional): An optional business friendly name , attributes (Array[attribute], optional): Custom user-defined metadata associated with this Business Object Definition. "name" is the attribute name (i.e. the key) and "value" is the attribute value. } attribute { name (string): Attribute key , value (string, optional): Attribute value } `{ "description": "string", "displayName": "string", "attributes": [ { "name": "string", "value": "string" } ] }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <businessObjectDefinitionUpdateRequest> <description>string</description> <displayName>string</displayName> <attributes> <attribute> <name>string</name> <value>string</value> </attribute> </attributes> </businessObjectDefinitionUpdateRequest>` Click to set as parameter value

Response (Status 200)

businessObjectDefinition {

id (integer, optional):

The internal identifier that uniquely references a Business Object Definition

,

namespace (string):

The name of a valid Namespace known by the system

,

businessObjectDefinitionName (string):

The name for this Business Object Definition

,

dataProviderName (string, optional):

The name of a valid Data Provider known by the system

,

description (string, optional):

An optional description

,

shortDescription (string, optional):

              An optional short-description. This is actually the 'description' field truncated to a configurable number of characters.

,

displayName (string, optional):

An optional business friendly name

,

attributes (Array[attribute], optional):

Custom user-defined metadata associated with this Business Object Definition. "name" is the attribute name (i.e. the key) and "value" is the attribute value

,

descriptiveBusinessObjectFormat (descriptiveBusinessObjectFormat, optional):

An optional business object definition descriptive format. The descriptive format is the single Business Object Format that will be used to represent this Business Object Definition to consumers

,

sampleDataFiles (Array[sampleDataFile], optional):

              An optional list of sample data files associated with the Business Object Definition

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}
descriptiveBusinessObjectFormat {

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format

,

businessObjectFormatFileType (string):

The File type for this Business Object Format

,

businessObjectFormatVersion (integer, optional):

The numeric version of a Business Object Format. Each time a format is registered, the new version will be the previous version

+ 1

}
sampleDataFile {

directoryPath (string):

The directory path of the sample data file. Note that directory path will contain a trailing "directory" separator, thus the caller needs to concatenate the directory path and the file name as is in order to construct a fully qualified path for the sample data file

,

fileName (string):

The name of the sample data file

}

{
  "id": 0,
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "dataProviderName": "string",
  "description": "string",
  "shortDescription": "string",
  "displayName": "string",
  "attributes": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "descriptiveBusinessObjectFormat": {
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0
  },
  "sampleDataFiles": [
    {
      "directoryPath": "string",
      "fileName": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDefinition>
     <id>0</id>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <dataProviderName>string</dataProviderName>
     <description>string</description>
     <shortDescription>string</shortDescription>
     <displayName>string</displayName>
     <attributes>
          <attribute>
               <name>string</name>
               <value>string</value>
          </attribute>
     </attributes>
     <descriptiveBusinessObjectFormat>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
     </descriptiveBusinessObjectFormat>
     <sampleDataFiles>
          <sampleDataFile>
               <directoryPath>string</directoryPath>
               <fileName>string</fileName>
          </sampleDataFile>
     </sampleDataFiles>
</businessObjectDefinition>

Response Content Type

post /businessObjectDefinitions/search

searchBusinessObjectDefinitions

Implementation Notes

Searches across all business object definitions that are defined in the system per specified search filters and keys

Parameters

Parameter	Value	Description	Parameter Type	Data Type
fields		A comma-separated list of fields to be retrieved with each business object definition entity. Valid options: dataProviderName, shortDescription, displayName	query	string
businessObjectDefinitionSearchRequest: the information needed to search across the business object definitions	Parameter content type: Model JSON Schema XML Example businessObjectDefinitionSearchRequest { businessObjectDefinitionSearchFilters (Array[businessObjectDefinitionSearchFilter], optional): A list of business Object Definition search filters. Only a single search filter is supported } businessObjectDefinitionSearchFilter { businessObjectDefinitionSearchKeys (Array[businessObjectDefinitionSearchKey], optional): A list of business Object Definition search keys. Only a single search key is supported } businessObjectDefinitionSearchKey { tagKey (tagKey): Values that uniquely identify a Tag , includeTagHierarchy (boolean, optional): An optional boolean flag that specifies if business object definition associated with entire tag hierarchy is to be retrieved } tagKey { tagTypeCode (string): The tag type reference code , tagCode (string): The tag reference code } `{ "businessObjectDefinitionSearchFilters": [ { "businessObjectDefinitionSearchKeys": [ { "tagKey": { "tagTypeCode": "string", "tagCode": "string" }, "includeTagHierarchy": true } ] } ] }` Click to set as parameter value <?xml version="1.0" encoding="UTF-8"?> <businessObjectDefinitionSearchRequest> <businessObjectDefinitionSearchFilters> <businessObjectDefinitionSearchFilter> <businessObjectDefinitionSearchKeys> <businessObjectDefinitionSearchKey> <tagKey> <tagTypeCode>string</tagTypeCode> <tagCode>string</tagCode> </tagKey> <includeTagHierarchy>true</includeTagHierarchy> </businessObjectDefinitionSearchKey> </businessObjectDefinitionSearchKeys> </businessObjectDefinitionSearchFilter> </businessObjectDefinitionSearchFilters> </businessObjectDefinitionSearchRequest> Click to set as parameter value

Response (Status 200)

businessObjectDefinitionSearchResponse {

businessObjectDefinitions (Array[businessObjectDefinition], optional):

              Values that identify a business object definition search response.

}
businessObjectDefinition {

id (integer, optional):

The internal identifier that uniquely references a Business Object Definition

,

namespace (string):

The name of a valid Namespace known by the system

,

businessObjectDefinitionName (string):

The name for this Business Object Definition

,

dataProviderName (string, optional):

The name of a valid Data Provider known by the system

,

description (string, optional):

An optional description

,

shortDescription (string, optional):

              An optional short-description. This is actually the 'description' field truncated to a configurable number of characters.

,

displayName (string, optional):

An optional business friendly name

,

attributes (Array[attribute], optional):

Custom user-defined metadata associated with this Business Object Definition. "name" is the attribute name (i.e. the key) and "value" is the attribute value

,

descriptiveBusinessObjectFormat (descriptiveBusinessObjectFormat, optional):

An optional business object definition descriptive format. The descriptive format is the single Business Object Format that will be used to represent this Business Object Definition to consumers

,

sampleDataFiles (Array[sampleDataFile], optional):

              An optional list of sample data files associated with the Business Object Definition

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}
descriptiveBusinessObjectFormat {

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format

,

businessObjectFormatFileType (string):

The File type for this Business Object Format

,

businessObjectFormatVersion (integer, optional):

The numeric version of a Business Object Format. Each time a format is registered, the new version will be the previous version

+ 1

}
sampleDataFile {

directoryPath (string):

The directory path of the sample data file. Note that directory path will contain a trailing "directory" separator, thus the caller needs to concatenate the directory path and the file name as is in order to construct a fully qualified path for the sample data file

,

fileName (string):

The name of the sample data file

}

{
  "businessObjectDefinitions": [
    "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<businessObjectDefinition>\n   <id>0</id>\n   <namespace>string</namespace>\n   <businessObjectDefinitionName>string</businessObjectDefinitionName>\n   <dataProviderName>string</dataProviderName>\n   <description>string</description>\n   <shortDescription>string</shortDescription>\n   <displayName>string</displayName>\n   <attributes>\n      <attribute>\n         <name>string</name>\n         <value>string</value>\n      </attribute>\n   </attributes>\n   <descriptiveBusinessObjectFormat>\n      <businessObjectFormatUsage>string</businessObjectFormatUsage>\n      <businessObjectFormatFileType>string</businessObjectFormatFileType>\n      <businessObjectFormatVersion>0</businessObjectFormatVersion>\n   </descriptiveBusinessObjectFormat>\n   <sampleDataFiles>\n      <sampleDataFile>\n         <directoryPath>string</directoryPath>\n         <fileName>string</fileName>\n      </sampleDataFile>\n   </sampleDataFiles>\n</businessObjectDefinition>\n"
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDefinitionSearchResponse>
     <businessObjectDefinitions>
          <businessObjectDefinition>
               <id>0</id>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <dataProviderName>string</dataProviderName>
               <description>string</description>
               <shortDescription>string</shortDescription>
               <displayName>string</displayName>
               <attributes>
                    <attribute>
                         <name>string</name>
                         <value>string</value>
                    </attribute>
               </attributes>
               <descriptiveBusinessObjectFormat>
                    <businessObjectFormatUsage>string</businessObjectFormatUsage>
                    <businessObjectFormatFileType>string</businessObjectFormatFileType>
                    <businessObjectFormatVersion>0</businessObjectFormatVersion>
               </descriptiveBusinessObjectFormat>
               <sampleDataFiles>
                    <sampleDataFile>
                         <directoryPath>string</directoryPath>
                         <fileName>string</fileName>
                    </sampleDataFile>
               </sampleDataFiles>
          </businessObjectDefinition>
     </businessObjectDefinitions>
</businessObjectDefinitionSearchResponse>

Response Content Type

- get /businessObjectDefinitions/validateindex
  - validateIndexBusinessObjectDefinitions
  Implementation Notes
  
  Validate all business object definitions in the index
  Response (Status 200)
  Model
  
  JSON Schema
  
  XML Example
  
  businessObjectDefinitionValidateResponse {
  validateStartTime (string, optional):
  The timestamp of when the index validation started
  ,
  sizeCheckPassed (boolean, optional):
  A Y/N flag that shows whether the total number of business object definitions in the database is the same as the total number in the index.
  ,
  spotCheckRandomPassed (boolean, optional):
  A Y/N flag that shows whether the spot check that verifies a percentage of random business object definitions in the database are the same as the indexed documents.
  ,
  spotCheckMostRecentPassed (boolean, optional):
  A Y/N flag that shows whether the spot check that verifies the most recently modified business object definitions in the database are the same as the indexed documents.
  
  }
  
  { "validateStartTime": "2017-04-29T14:40:26.845Z", "sizeCheckPassed": true, "spotCheckRandomPassed": true, "spotCheckMostRecentPassed": true }
  
  <?xml version="1.0" encoding="UTF-8"?> <businessObjectDefinitionValidateResponse> <validateStartTime>2015-12-25T00:00:00.000-05:00</validateStartTime> <sizeCheckPassed>true</sizeCheckPassed> <spotCheckRandomPassed>true</spotCheckRandomPassed> <spotCheckMostRecentPassed>true</spotCheckMostRecentPassed> </businessObjectDefinitionValidateResponse>
  Response Content Type
  
  Hide Response
  Curl
  
  Request URL
  
  Response Body
  
  Response Code

Business Object Definition Column

post /businessObjectDefinitionColumns

createBusinessObjectDefinitionColumn

Implementation Notes

Creates a new business object definition column.

Parameter (body): the information needed to create a business object definition column
Parameter content type: Model JSON Schema XML Example businessObjectDefinitionColumnCreateRequest { businessObjectDefinitionColumnKey (businessObjectDefinitionColumnKey): Values that uniquely identify a Business Object Definition Column , schemaColumnName (string): The name of the schema column , description (string, optional): Description of the Business Object Definition Column } businessObjectDefinitionColumnKey { namespace (string): The namespace of the Business Object Definition , businessObjectDefinitionName (string): The name of the Business Object Definition , businessObjectDefinitionColumnName (string): The name of the Business Object Definition Column } `{ "businessObjectDefinitionColumnKey": { "namespace": "string", "businessObjectDefinitionName": "string", "businessObjectDefinitionColumnName": "string" }, "schemaColumnName": "string", "description": "string" }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <businessObjectDefinitionColumnCreateRequest> <businessObjectDefinitionColumnKey> <namespace>string</namespace> <businessObjectDefinitionName>string</businessObjectDefinitionName> <businessObjectDefinitionColumnName>string</businessObjectDefinitionColumnName> </businessObjectDefinitionColumnKey> <schemaColumnName>string</schemaColumnName> <description>string</description> </businessObjectDefinitionColumnCreateRequest>` Click to set as parameter value

Response (Status 200)

businessObjectDefinitionColumn {

id (integer, optional):

The internal Id that uniquely references a Business Object Definition Column

,

businessObjectDefinitionColumnKey (businessObjectDefinitionColumnKey):

Values that uniquely identify a Business Object Definition Column

,

schemaColumnName (string, optional):

The name of the schema column

,

description (string, optional):

Description of the Business Object Definition Column

}
businessObjectDefinitionColumnKey {

namespace (string):

The namespace of the Business Object Definition

,

businessObjectDefinitionName (string):

The name of the Business Object Definition

,

businessObjectDefinitionColumnName (string):

The name of the Business Object Definition Column

}

{
  "id": 0,
  "businessObjectDefinitionColumnKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectDefinitionColumnName": "string"
  },
  "schemaColumnName": "string",
  "description": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDefinitionColumn>
     <id>0</id>
     <businessObjectDefinitionColumnKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectDefinitionColumnName>string</businessObjectDefinitionColumnName>
     </businessObjectDefinitionColumnKey>
     <schemaColumnName>string</schemaColumnName>
     <description>string</description>
</businessObjectDefinitionColumn>

Response Content Type

get /businessObjectDefinitionColumns/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}

getBusinessObjectDefinitionColumns

Implementation Notes

Gets a list of keys for all existing business object definition columns for a specific business object definition.

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace of the business object definition	path	string
businessObjectDefinitionName		the name of the business object definition	path	string

Response (Status 200)

businessObjectDefinitionColumnKeys {

businessObjectDefinitionColumnKeys (Array[businessObjectDefinitionColumnKey], optional)

}
businessObjectDefinitionColumnKey {

namespace (string):

The namespace of the Business Object Definition

,

businessObjectDefinitionName (string):

The name of the Business Object Definition

,

businessObjectDefinitionColumnName (string):

The name of the Business Object Definition Column

}

{
  "businessObjectDefinitionColumnKeys": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectDefinitionColumnName": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDefinitionColumnKeys>
     <businessObjectDefinitionColumnKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectDefinitionColumnName>string</businessObjectDefinitionColumnName>
     </businessObjectDefinitionColumnKey>
</businessObjectDefinitionColumnKeys>

Response Content Type

delete /businessObjectDefinitionColumns/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectDefinitionColumnNames/{businessObjectDefinitionColumnName}

deleteBusinessObjectDefinitionColumn

Implementation Notes

Deletes an existing column for the business object definition.

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace of the business object definition	path	string
businessObjectDefinitionName	the name of the business object definition	path	string
businessObjectDefinitionColumnName	the name of the business object definition column	path	string

Response (Status 200)

businessObjectDefinitionColumn {

id (integer, optional):

The internal Id that uniquely references a Business Object Definition Column

,

businessObjectDefinitionColumnKey (businessObjectDefinitionColumnKey):

Values that uniquely identify a Business Object Definition Column

,

schemaColumnName (string, optional):

The name of the schema column

,

description (string, optional):

Description of the Business Object Definition Column

}
businessObjectDefinitionColumnKey {

namespace (string):

The namespace of the Business Object Definition

,

businessObjectDefinitionName (string):

The name of the Business Object Definition

,

businessObjectDefinitionColumnName (string):

The name of the Business Object Definition Column

}

{
  "id": 0,
  "businessObjectDefinitionColumnKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectDefinitionColumnName": "string"
  },
  "schemaColumnName": "string",
  "description": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDefinitionColumn>
     <id>0</id>
     <businessObjectDefinitionColumnKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectDefinitionColumnName>string</businessObjectDefinitionColumnName>
     </businessObjectDefinitionColumnKey>
     <schemaColumnName>string</schemaColumnName>
     <description>string</description>
</businessObjectDefinitionColumn>

Response Content Type

get /businessObjectDefinitionColumns/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectDefinitionColumnNames/{businessObjectDefinitionColumnName}

getBusinessObjectDefinitionColumn

Implementation Notes

Gets an existing column for the business object definition.

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace of the business object definition	path	string
businessObjectDefinitionName	the name of the business object definition	path	string
businessObjectDefinitionColumnName	the name of the business object definition column	path	string

Response (Status 200)

businessObjectDefinitionColumn {

id (integer, optional):

The internal Id that uniquely references a Business Object Definition Column

,

businessObjectDefinitionColumnKey (businessObjectDefinitionColumnKey):

Values that uniquely identify a Business Object Definition Column

,

schemaColumnName (string, optional):

The name of the schema column

,

description (string, optional):

Description of the Business Object Definition Column

}
businessObjectDefinitionColumnKey {

namespace (string):

The namespace of the Business Object Definition

,

businessObjectDefinitionName (string):

The name of the Business Object Definition

,

businessObjectDefinitionColumnName (string):

The name of the Business Object Definition Column

}

{
  "id": 0,
  "businessObjectDefinitionColumnKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectDefinitionColumnName": "string"
  },
  "schemaColumnName": "string",
  "description": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDefinitionColumn>
     <id>0</id>
     <businessObjectDefinitionColumnKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectDefinitionColumnName>string</businessObjectDefinitionColumnName>
     </businessObjectDefinitionColumnKey>
     <schemaColumnName>string</schemaColumnName>
     <description>string</description>
</businessObjectDefinitionColumn>

Response Content Type

put /businessObjectDefinitionColumns/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectDefinitionColumnNames/{businessObjectDefinitionColumnName}

updateBusinessObjectDefinitionColumn

Implementation Notes

Updates an existing column for the business object definition.

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace of the business object definition	path	string
businessObjectDefinitionName		the name of the business object definition	path	string
businessObjectDefinitionColumnName		the name of the business object definition column	path	string
businessObjectDefinitionColumnUpdateRequest: the request information needed to update the business object definition column	Parameter content type: Model JSON Schema XML Example businessObjectDefinitionColumnUpdateRequest { description (string, optional): Description of the Business Object Definition Column } `{ "description": "string" }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <businessObjectDefinitionColumnUpdateRequest> <description>string</description> </businessObjectDefinitionColumnUpdateRequest>` Click to set as parameter value

Response (Status 200)

businessObjectDefinitionColumn {

id (integer, optional):

The internal Id that uniquely references a Business Object Definition Column

,

businessObjectDefinitionColumnKey (businessObjectDefinitionColumnKey):

Values that uniquely identify a Business Object Definition Column

,

schemaColumnName (string, optional):

The name of the schema column

,

description (string, optional):

Description of the Business Object Definition Column

}
businessObjectDefinitionColumnKey {

namespace (string):

The namespace of the Business Object Definition

,

businessObjectDefinitionName (string):

The name of the Business Object Definition

,

businessObjectDefinitionColumnName (string):

The name of the Business Object Definition Column

}

{
  "id": 0,
  "businessObjectDefinitionColumnKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectDefinitionColumnName": "string"
  },
  "schemaColumnName": "string",
  "description": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDefinitionColumn>
     <id>0</id>
     <businessObjectDefinitionColumnKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectDefinitionColumnName>string</businessObjectDefinitionColumnName>
     </businessObjectDefinitionColumnKey>
     <schemaColumnName>string</schemaColumnName>
     <description>string</description>
</businessObjectDefinitionColumn>

Response Content Type

post /businessObjectDefinitionColumns/search

searchBusinessObjectDefinitionColumns

Implementation Notes

Retrieve a list of business object definition columns meeting the search criteria filters and fields request.

Parameters

Parameter	Value	Description	Parameter Type	Data Type
fields		the field options for the business object definition columns search response. The valid field options are: description, schemaColumnName	query	string
businessObjectDefinitionColumnSearchRequest: the search criteria needed to find a list of business object definition columns	Parameter content type: Model JSON Schema XML Example businessObjectDefinitionColumnSearchRequest { businessObjectDefinitionColumnSearchFilters (Array[businessObjectDefinitionColumnSearchFilter], optional) } businessObjectDefinitionColumnSearchFilter { businessObjectDefinitionColumnSearchKeys (Array[businessObjectDefinitionColumnSearchKey], optional): A list of business object definition column search keys. Only a single search key is supported } businessObjectDefinitionColumnSearchKey { namespace (string, optional): The namespace to which a business object definition column is related , businessObjectDefinitionName (string, optional): The name of the business object definition to which a business object definition column is related } `{ "businessObjectDefinitionColumnSearchFilters": [ { "businessObjectDefinitionColumnSearchKeys": [ { "namespace": "string", "businessObjectDefinitionName": "string" } ] } ] }` Click to set as parameter value <?xml version="1.0" encoding="UTF-8"?> <businessObjectDefinitionColumnSearchRequest> <businessObjectDefinitionColumnSearchFilters> <businessObjectDefinitionColumnSearchFilter> <businessObjectDefinitionColumnSearchKeys> <businessObjectDefinitionColumnSearchKey> <namespace>string</namespace> <businessObjectDefinitionName>string</businessObjectDefinitionName> </businessObjectDefinitionColumnSearchKey> </businessObjectDefinitionColumnSearchKeys> </businessObjectDefinitionColumnSearchFilter> </businessObjectDefinitionColumnSearchFilters> </businessObjectDefinitionColumnSearchRequest> Click to set as parameter value

Response (Status 200)

businessObjectDefinitionColumnSearchResponse {

businessObjectDefinitionColumns (Array[businessObjectDefinitionColumn], optional):

An ordered list of business object definition columns. The list is sorted alphabetically by business object definition column name ascending

}
businessObjectDefinitionColumn {

id (integer, optional):

The internal Id that uniquely references a Business Object Definition Column

,

businessObjectDefinitionColumnKey (businessObjectDefinitionColumnKey):

Values that uniquely identify a Business Object Definition Column

,

schemaColumnName (string, optional):

The name of the schema column

,

description (string, optional):

Description of the Business Object Definition Column

}
businessObjectDefinitionColumnKey {

namespace (string):

The namespace of the Business Object Definition

,

businessObjectDefinitionName (string):

The name of the Business Object Definition

,

businessObjectDefinitionColumnName (string):

The name of the Business Object Definition Column

}

{
  "businessObjectDefinitionColumns": [
    "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<businessObjectDefinitionColumn>\n   <id>0</id>\n   <businessObjectDefinitionColumnKey>\n      <namespace>string</namespace>\n      <businessObjectDefinitionName>string</businessObjectDefinitionName>\n      <businessObjectDefinitionColumnName>string</businessObjectDefinitionColumnName>\n   </businessObjectDefinitionColumnKey>\n   <schemaColumnName>string</schemaColumnName>\n   <description>string</description>\n</businessObjectDefinitionColumn>\n"
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDefinitionColumnSearchResponse>
     <businessObjectDefinitionColumns>
          <businessObjectDefinitionColumn>
               <id>0</id>
               <businessObjectDefinitionColumnKey>
                    <namespace>string</namespace>
                    <businessObjectDefinitionName>string</businessObjectDefinitionName>
                    <businessObjectDefinitionColumnName>string</businessObjectDefinitionColumnName>
               </businessObjectDefinitionColumnKey>
               <schemaColumnName>string</schemaColumnName>
               <description>string</description>
          </businessObjectDefinitionColumn>
     </businessObjectDefinitionColumns>
</businessObjectDefinitionColumnSearchResponse>

Response Content Type

Business Object Definition Subject Matter Expert

post /businessObjectDefinitionSubjectMatterExperts

createBusinessObjectDefinitionSubjectMatterExpert

Implementation Notes

Creates a new business object definition subject matter expert.

Parameter (body): the information needed to create a business object definition subject matter expert
Parameter content type: Model JSON Schema XML Example businessObjectDefinitionSubjectMatterExpertCreateRequest { businessObjectDefinitionSubjectMatterExpertKey (businessObjectDefinitionSubjectMatterExpertKey): Values that uniquely identify a Business Object Definition Subject Matter Expert } businessObjectDefinitionSubjectMatterExpertKey { namespace (string): The namespace of the Business Object Definition , businessObjectDefinitionName (string): The name of the Business Object Definition , userId (string): The user id of the Subject Matter Expert } `{ "businessObjectDefinitionSubjectMatterExpertKey": { "namespace": "string", "businessObjectDefinitionName": "string", "userId": "string" } }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <businessObjectDefinitionSubjectMatterExpertCreateRequest> <businessObjectDefinitionSubjectMatterExpertKey> <namespace>string</namespace> <businessObjectDefinitionName>string</businessObjectDefinitionName> <userId>string</userId> </businessObjectDefinitionSubjectMatterExpertKey> </businessObjectDefinitionSubjectMatterExpertCreateRequest>` Click to set as parameter value

Response (Status 200)

businessObjectDefinitionSubjectMatterExpert {

id (integer, optional):

The internal Id that uniquely references a Business Object Definition Subject Matter Expert

,

businessObjectDefinitionSubjectMatterExpertKey (businessObjectDefinitionSubjectMatterExpertKey):

Values that uniquely identify a Business Object Definition Subject Matter Expert

}
businessObjectDefinitionSubjectMatterExpertKey {

namespace (string):

The namespace of the Business Object Definition

,

businessObjectDefinitionName (string):

The name of the Business Object Definition

,

userId (string):

The user id of the Subject Matter Expert

}

{
  "id": 0,
  "businessObjectDefinitionSubjectMatterExpertKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "userId": "string"
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDefinitionSubjectMatterExpert>
     <id>0</id>
     <businessObjectDefinitionSubjectMatterExpertKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <userId>string</userId>
     </businessObjectDefinitionSubjectMatterExpertKey>
</businessObjectDefinitionSubjectMatterExpert>

Response Content Type

get /businessObjectDefinitionSubjectMatterExperts/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}

getBusinessObjectDefinitionSubjectMatterExpertsByBusinessObjectDefinition

Implementation Notes

Gets a list of keys for all existing business object definition subject matter experts for the specified business object definition.

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace of the business object definition	path	string
businessObjectDefinitionName		the name of the business object definition	path	string

Response (Status 200)

businessObjectDefinitionSubjectMatterExpertKeys {

businessObjectDefinitionSubjectMatterExpertKeys (Array[businessObjectDefinitionSubjectMatterExpertKey], optional)

}
businessObjectDefinitionSubjectMatterExpertKey {

namespace (string):

The namespace of the Business Object Definition

,

businessObjectDefinitionName (string):

The name of the Business Object Definition

,

userId (string):

The user id of the Subject Matter Expert

}

{
  "businessObjectDefinitionSubjectMatterExpertKeys": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "userId": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDefinitionSubjectMatterExpertKeys>
     <businessObjectDefinitionSubjectMatterExpertKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <userId>string</userId>
     </businessObjectDefinitionSubjectMatterExpertKey>
</businessObjectDefinitionSubjectMatterExpertKeys>

Response Content Type

delete /businessObjectDefinitionSubjectMatterExperts/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/userIds/{userId}

deleteBusinessObjectDefinitionSubjectMatterExpert

Implementation Notes

Deletes an existing business object definition subject matter expert.

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace of the business object definition	path	string
businessObjectDefinitionName	the name of the business object definition	path	string
userId	the user id of the subject matter expert	path	string

Response (Status 200)

businessObjectDefinitionSubjectMatterExpert {

id (integer, optional):

The internal Id that uniquely references a Business Object Definition Subject Matter Expert

,

businessObjectDefinitionSubjectMatterExpertKey (businessObjectDefinitionSubjectMatterExpertKey):

Values that uniquely identify a Business Object Definition Subject Matter Expert

}
businessObjectDefinitionSubjectMatterExpertKey {

namespace (string):

The namespace of the Business Object Definition

,

businessObjectDefinitionName (string):

The name of the Business Object Definition

,

userId (string):

The user id of the Subject Matter Expert

}

{
  "id": 0,
  "businessObjectDefinitionSubjectMatterExpertKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "userId": "string"
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDefinitionSubjectMatterExpert>
     <id>0</id>
     <businessObjectDefinitionSubjectMatterExpertKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <userId>string</userId>
     </businessObjectDefinitionSubjectMatterExpertKey>
</businessObjectDefinitionSubjectMatterExpert>

Response Content Type

Business Object Definition Tag

post /businessObjectDefinitionTags

createBusinessObjectDefinitionTag

Implementation Notes

Creates a new business object definition tag.

Parameter (body): the information needed to create a business object definition tag
Parameter content type: Model JSON Schema XML Example businessObjectDefinitionTagCreateRequest { businessObjectDefinitionTagKey (businessObjectDefinitionTagKey): Values that uniquely identify a Business Object Definition Tag } businessObjectDefinitionTagKey { businessObjectDefinitionKey (businessObjectDefinitionKey): Values that uniquely identify a Business Object Definition , tagKey (tagKey): Values that uniquely identify a Tag } businessObjectDefinitionKey { namespace (string): The name of a valid Namespace known by the system , businessObjectDefinitionName (string): The name for this Business Object Definition } tagKey { tagTypeCode (string): The tag type reference code , tagCode (string): The tag reference code } `{ "businessObjectDefinitionTagKey": { "businessObjectDefinitionKey": { "namespace": "string", "businessObjectDefinitionName": "string" }, "tagKey": { "tagTypeCode": "string", "tagCode": "string" } } }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <businessObjectDefinitionTagCreateRequest> <businessObjectDefinitionTagKey> <businessObjectDefinitionKey> <namespace>string</namespace> <businessObjectDefinitionName>string</businessObjectDefinitionName> </businessObjectDefinitionKey> <tagKey> <tagTypeCode>string</tagTypeCode> <tagCode>string</tagCode> </tagKey> </businessObjectDefinitionTagKey> </businessObjectDefinitionTagCreateRequest>` Click to set as parameter value

Response (Status 200)

businessObjectDefinitionTag {

id (integer, optional):

The internal Id that uniquely references a Business Object Definition Tag

,

businessObjectDefinitionTagKey (businessObjectDefinitionTagKey):

Values that uniquely identify a Business Object Definition Tag

}
businessObjectDefinitionTagKey {

businessObjectDefinitionKey (businessObjectDefinitionKey):

Values that uniquely identify a Business Object Definition

,

tagKey (tagKey):

Values that uniquely identify a Tag

}
businessObjectDefinitionKey {

namespace (string):

The name of a valid Namespace known by the system

,

businessObjectDefinitionName (string):

The name for this Business Object Definition

}
tagKey {

tagTypeCode (string):

The tag type reference code

,

tagCode (string):

The tag reference code

}

{
  "id": 0,
  "businessObjectDefinitionTagKey": {
    "businessObjectDefinitionKey": {
      "namespace": "string",
      "businessObjectDefinitionName": "string"
    },
    "tagKey": {
      "tagTypeCode": "string",
      "tagCode": "string"
    }
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDefinitionTag>
     <id>0</id>
     <businessObjectDefinitionTagKey>
          <businessObjectDefinitionKey>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
          </businessObjectDefinitionKey>
          <tagKey>
               <tagTypeCode>string</tagTypeCode>
               <tagCode>string</tagCode>
          </tagKey>
     </businessObjectDefinitionTagKey>
</businessObjectDefinitionTag>

Response Content Type

get /businessObjectDefinitionTags/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}

getBusinessObjectDefinitionTagsByBusinessObjectDefinition

Implementation Notes

Gets a list of keys for all existing business object definition tags that are associated with the specified business object definition.

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace of the business object definition	path	string
businessObjectDefinitionName		the name of the business object definition	path	string

Response (Status 200)

businessObjectDefinitionTagKeys {

businessObjectDefinitionTagKeys (Array[businessObjectDefinitionTagKey], optional)

}
businessObjectDefinitionTagKey {

businessObjectDefinitionKey (businessObjectDefinitionKey):

Values that uniquely identify a Business Object Definition

,

tagKey (tagKey):

Values that uniquely identify a Tag

}
businessObjectDefinitionKey {

namespace (string):

The name of a valid Namespace known by the system

,

businessObjectDefinitionName (string):

The name for this Business Object Definition

}
tagKey {

tagTypeCode (string):

The tag type reference code

,

tagCode (string):

The tag reference code

}

{
  "businessObjectDefinitionTagKeys": [
    {
      "businessObjectDefinitionKey": {
        "namespace": "string",
        "businessObjectDefinitionName": "string"
      },
      "tagKey": {
        "tagTypeCode": "string",
        "tagCode": "string"
      }
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDefinitionTagKeys>
     <businessObjectDefinitionTagKey>
          <businessObjectDefinitionKey>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
          </businessObjectDefinitionKey>
          <tagKey>
               <tagTypeCode>string</tagTypeCode>
               <tagCode>string</tagCode>
          </tagKey>
     </businessObjectDefinitionTagKey>
</businessObjectDefinitionTagKeys>

Response Content Type

delete /businessObjectDefinitionTags/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/tagTypes/{tagTypeCode}/tagCodes/{tagCode}

deleteBusinessObjectDefinitionTag

Implementation Notes

Deletes an existing business object definition tag.

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace of the business object definition	path	string
businessObjectDefinitionName	the name of the business object definition	path	string
tagTypeCode	the tag type reference code of the tag	path	string
tagCode	the tag reference code of the tag	path	string

Response (Status 200)

businessObjectDefinitionTag {

id (integer, optional):

The internal Id that uniquely references a Business Object Definition Tag

,

businessObjectDefinitionTagKey (businessObjectDefinitionTagKey):

Values that uniquely identify a Business Object Definition Tag

}
businessObjectDefinitionTagKey {

businessObjectDefinitionKey (businessObjectDefinitionKey):

Values that uniquely identify a Business Object Definition

,

tagKey (tagKey):

Values that uniquely identify a Tag

}
businessObjectDefinitionKey {

namespace (string):

The name of a valid Namespace known by the system

,

businessObjectDefinitionName (string):

The name for this Business Object Definition

}
tagKey {

tagTypeCode (string):

The tag type reference code

,

tagCode (string):

The tag reference code

}

{
  "id": 0,
  "businessObjectDefinitionTagKey": {
    "businessObjectDefinitionKey": {
      "namespace": "string",
      "businessObjectDefinitionName": "string"
    },
    "tagKey": {
      "tagTypeCode": "string",
      "tagCode": "string"
    }
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDefinitionTag>
     <id>0</id>
     <businessObjectDefinitionTagKey>
          <businessObjectDefinitionKey>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
          </businessObjectDefinitionKey>
          <tagKey>
               <tagTypeCode>string</tagTypeCode>
               <tagCode>string</tagCode>
          </tagKey>
     </businessObjectDefinitionTagKey>
</businessObjectDefinitionTag>

Response Content Type

get /businessObjectDefinitionTags/tagTypes/{tagTypeCode}/tagCodes/{tagCode}

getBusinessObjectDefinitionTagsByTag

Implementation Notes

Gets a list of keys for all existing business object definition tags that are associated with the specified tag.

Parameters

Parameter	Value	Description	Parameter Type	Data Type
tagTypeCode		the tag type reference code	path	string
tagCode		the tag reference code	path	string

Response (Status 200)

businessObjectDefinitionTagKeys {

businessObjectDefinitionTagKeys (Array[businessObjectDefinitionTagKey], optional)

}
businessObjectDefinitionTagKey {

businessObjectDefinitionKey (businessObjectDefinitionKey):

Values that uniquely identify a Business Object Definition

,

tagKey (tagKey):

Values that uniquely identify a Tag

}
businessObjectDefinitionKey {

namespace (string):

The name of a valid Namespace known by the system

,

businessObjectDefinitionName (string):

The name for this Business Object Definition

}
tagKey {

tagTypeCode (string):

The tag type reference code

,

tagCode (string):

The tag reference code

}

{
  "businessObjectDefinitionTagKeys": [
    {
      "businessObjectDefinitionKey": {
        "namespace": "string",
        "businessObjectDefinitionName": "string"
      },
      "tagKey": {
        "tagTypeCode": "string",
        "tagCode": "string"
      }
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectDefinitionTagKeys>
     <businessObjectDefinitionTagKey>
          <businessObjectDefinitionKey>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
          </businessObjectDefinitionKey>
          <tagKey>
               <tagTypeCode>string</tagTypeCode>
               <tagCode>string</tagCode>
          </tagKey>
     </businessObjectDefinitionTagKey>
</businessObjectDefinitionTagKeys>

Response Content Type

Business Object Format

post /businessObjectFormats

createBusinessObjectFormat

Implementation Notes

Creates a new business object format.

Requires WRITE permission on namespace

Parameter (body): the information needed to create the business object format.
Parameter content type: Model JSON Schema XML Example businessObjectFormatCreateRequest { namespace (string): The Namespace to which this Business Object Format is related , businessObjectDefinitionName (string): The name of the Business Object Definition to which this Business Object Format is related , businessObjectFormatUsage (string): The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions , businessObjectFormatFileType (string): A File Type known to the system that describes the file type of data stored under this Business Object Format , partitionKey (string): The partition key for this Business Object Format , description (string, optional): Description of the Business Object Format , attributes (Array[attribute], optional): Custom user-defined metadata associated with this Business Object Format. "name" is the attribute name (i.e. the key) and "value" is the attribute value. , attributeDefinitions (Array[attributeDefinition], optional): List of attribute definitions (for storage of custom user-defined metadata with objects) which are required to be specified when registering Business Object Data against this format. This list will define which metadata must be specified, but additional metadata can still be registered which is not specified in this list. The metadata (attributes) will allow applications to store custom data with registered data for use by consumers of the data , schema (schema, optional): The schema associated with this Business Object Format } attribute { name (string): Attribute key , value (string, optional): Attribute value } attributeDefinition { name (string): Name of an Attribute that will be required when registering a Business Object Data of this Business Object Format , publish (boolean, optional): `If true, this business object data attribute will be published in notification messages` } schema { columns (Array[schemaColumn], optional): A container for Schema Columns that are present in data file(s) for this Business Object Format. Required when Schema is present , partitions (Array[schemaColumn], optional): A container for partition columns in a specific schema. A schema might have zero, one or more partition columns. If a partition column is present in the data file(s), it should also be listed as a regular column in the schema with all column information matching (case sensitive) , nullValue (string, optional): The string to use for the null value (e.g. "\\N"). Please note that a null value is allowed to be a whitespace character. XML escaping should be used when specifying non-ASCII characters. Note: when passing in an empty String, the response XML will return a NULL value (i.e. the tag will be absent). Generate DDL calls will show the correct empty String value wrapped in single-quotes. Required when Schema is present , delimiter (string, optional): The field delimiter (e.g. "\|"). Please note that a field delimiter is allowed to be a whitespace character. XML escaping should be used when specifying non-ASCII characters , escapeCharacter (string, optional): The escape character (e.g. "\\"). XML escaping should be used when specifying non-ASCII characters. , partitionKeyGroup (string, optional): The partition key group that this schema's partition or sub-partition key belongs to. This value will be used to identify the ordered set of Expected Partition Values when determining Business Object Data Availability or generating DDL using partition value ranges. A Partition Key Group value is required in the Business Object Format in order to use partition value ranges with the Availability and DDL services } schemaColumn { name (string): The name of the schema column. Required when Column is present , type (string): The data type of the schema column. Required when Column is present , size (string, optional): The column size. This is a string value since, for "NUMERIC" and "DECIMAL" data types, we should be able to specify both the maximum number of digits (p) that are present in the number and the maximum number of decimal places (s) as a "p,s" string. Required when Column is present , required (boolean, optional): Values true\|false. If true, a value isis required for the column (not nullable) , defaultValue (string, optional): Default value for the column , description (string, optional): Description of the column } { "namespace": "string", "businessObjectDefinitionName": "string", "businessObjectFormatUsage": "string", "businessObjectFormatFileType": "string", "partitionKey": "string", "description": "string", "attributes": [ { "name": "string", "value": "string" } ], "attributeDefinitions": [ { "name": "string", "publish": true } ], "schema": { "columns": [ { "name": "string", "type": "string", "size": "string", "required": true, "defaultValue": "string", "description": "string" } ], "partitions": [ { "name": "string", "type": "string", "size": "string", "required": true, "defaultValue": "string", "description": "string" } ], "nullValue": "string", "delimiter": "string", "escapeCharacter": "string", "partitionKeyGroup": "string" } } Click to set as parameter value <?xml version="1.0" encoding="UTF-8"?> <businessObjectFormatCreateRequest> <namespace>string</namespace> <businessObjectDefinitionName>string</businessObjectDefinitionName> <businessObjectFormatUsage>string</businessObjectFormatUsage> <businessObjectFormatFileType>string</businessObjectFormatFileType> <partitionKey>string</partitionKey> <description>string</description> <attributes> <attribute> <name>string</name> <value>string</value> </attribute> </attributes> <attributeDefinitions> <attributeDefinition> <name>string</name> <publish>true</publish> </attributeDefinition> </attributeDefinitions> <schema> <columns> <column> <name>string</name> <type>string</type> <size>string</size> <required>true</required> <defaultValue>string</defaultValue> <description>string</description> </column> </columns> <partitions> <column> <name>string</name> <type>string</type> <size>string</size> <required>true</required> <defaultValue>string</defaultValue> <description>string</description> </column> </partitions> <nullValue>string</nullValue> <delimiter>string</delimiter> <escapeCharacter>string</escapeCharacter> <partitionKeyGroup>string</partitionKeyGroup> </schema> </businessObjectFormatCreateRequest> Click to set as parameter value

Response (Status 200)

businessObjectFormat {

id (integer, optional):

The internal identifier that uniquely identifies a Business Object Format

,

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The numeric version of a Business Object Format. Each time a format is registered, the new version will be the previous version

+ 1

,

latestVersion (boolean, optional):

A Y/N flag that shows whether this instance of format is the latest or not. Once a new version of format is registered, any previous versions will no longer be the latest

,

partitionKey (string):

The partition key for this Business Object Format

,

description (string, optional):

Description of the Business Object Format

,

attributes (Array[attribute], optional):

Custom user-defined metadata associated with this Business Object Format. "name" is the attribute name (i.e. the key) and "value" is the attribute value.

,

attributeDefinitions (Array[attributeDefinition], optional):

List of attribute definitions (for storage of custom user-defined metadata with objects) which are required to be specified when registering Business Object Data against this format. This list will define which metadata must be specified, but additional metadata can still be registered which is not specified in this list. The metadata (attributes) will allow applications to store custom data with registered data for use by consumers of the data

,

schema (schema, optional):

The schema associated with this Business Object Format

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}
attributeDefinition {

name (string):

Name of an Attribute that will be required when registering a Business Object Data of this Business Object Format

,

publish (boolean, optional):

              If true, this business object data attribute will be published in notification messages

}
schema {

columns (Array[schemaColumn], optional):

A container for Schema Columns that are present in data file(s) for this Business Object Format. Required when Schema is present

,

partitions (Array[schemaColumn], optional):

A container for partition columns in a specific schema. A schema might have zero, one or more partition columns. If a partition column is present in the data file(s), it should also be listed as a regular column in the schema with all column information matching (case sensitive)

,

nullValue (string, optional):

The string to use for the null value (e.g. "\\N"). Please note that a null value is allowed to be a whitespace character. XML escaping should be used when specifying non-ASCII characters. Note: when passing in an empty String, the response XML will return a NULL value (i.e. the tag will be absent). Generate DDL calls will show the correct empty String value wrapped in single-quotes. Required when Schema is present

,

delimiter (string, optional):

The field delimiter (e.g. "|"). Please note that a field delimiter is allowed to be a whitespace character. XML escaping should be used when specifying non-ASCII characters

,

escapeCharacter (string, optional):

The escape character (e.g. "\\"). XML escaping should be used when specifying non-ASCII characters.

,

partitionKeyGroup (string, optional):

The partition key group that this schema's partition or sub-partition key belongs to. This value will be used to identify the ordered set of Expected Partition Values when determining Business Object Data Availability or generating DDL using partition value ranges. A Partition Key Group value is required in the Business Object Format in order to use partition value ranges with the Availability and DDL services

}
schemaColumn {

name (string):

The name of the schema column. Required when Column is present

,

type (string):

The data type of the schema column. Required when Column is present

,

size (string, optional):

The column size. This is a string value since, for "NUMERIC" and "DECIMAL" data types, we should be able to specify both the maximum number of digits (p) that are present in the number and the maximum number of decimal places (s) as a "p,s" string. Required when Column is present

,

required (boolean, optional):

Values true|false. If true, a value isis required for the column (not nullable)

,

defaultValue (string, optional):

Default value for the column

,

description (string, optional):

Description of the column

}

{
  "id": 0,
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "businessObjectFormatUsage": "string",
  "businessObjectFormatFileType": "string",
  "businessObjectFormatVersion": 0,
  "latestVersion": true,
  "partitionKey": "string",
  "description": "string",
  "attributes": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "attributeDefinitions": [
    {
      "name": "string",
      "publish": true
    }
  ],
  "schema": {
    "columns": [
      {
        "name": "string",
        "type": "string",
        "size": "string",
        "required": true,
        "defaultValue": "string",
        "description": "string"
      }
    ],
    "partitions": [
      {
        "name": "string",
        "type": "string",
        "size": "string",
        "required": true,
        "defaultValue": "string",
        "description": "string"
      }
    ],
    "nullValue": "string",
    "delimiter": "string",
    "escapeCharacter": "string",
    "partitionKeyGroup": "string"
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectFormat>
     <id>0</id>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <businessObjectFormatUsage>string</businessObjectFormatUsage>
     <businessObjectFormatFileType>string</businessObjectFormatFileType>
     <businessObjectFormatVersion>0</businessObjectFormatVersion>
     <latestVersion>true</latestVersion>
     <partitionKey>string</partitionKey>
     <description>string</description>
     <attributes>
          <attribute>
               <name>string</name>
               <value>string</value>
          </attribute>
     </attributes>
     <attributeDefinitions>
          <attributeDefinition>
               <name>string</name>
               <publish>true</publish>
          </attributeDefinition>
     </attributeDefinitions>
     <schema>
          <columns>
               <column>
                    <name>string</name>
                    <type>string</type>
                    <size>string</size>
                    <required>true</required>
                    <defaultValue>string</defaultValue>
                    <description>string</description>
               </column>
          </columns>
          <partitions>
               <column>
                    <name>string</name>
                    <type>string</type>
                    <size>string</size>
                    <required>true</required>
                    <defaultValue>string</defaultValue>
                    <description>string</description>
               </column>
          </partitions>
          <nullValue>string</nullValue>
          <delimiter>string</delimiter>
          <escapeCharacter>string</escapeCharacter>
          <partitionKeyGroup>string</partitionKeyGroup>
     </schema>
</businessObjectFormat>

Response Content Type

post /businessObjectFormats/generateDdl

generateBusinessObjectFormatDdl

Implementation Notes

Retrieves the DDL to initialize the specified type of the database system (e.g. Hive) by creating a table for the requested business object format.

Requires READ permission on namespace

Parameter (body): the business object data DDL request

Parameter content type:

businessObjectFormatDdlRequest {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The numeric version of a Business Object Format. If not supplied, the latest version will be used

,

outputFormat (string) = ['HIVE_13_DDL']

string
Enum:	"HIVE_13_DDL"

,

tableName (string):

The table name to be used in the generated DDL

,

customDdlName (string, optional):

The name of the Custom DDL. When Custom DDL name is specified, the Custom DDL which had previously been stored Business Object Format is returned instead of generated DDL. Must not be specified when replaceColumns is true

,

includeDropTableStatement (boolean, optional):

If true, drop table statement for existing table will be added to the generated DDL. Must not be specified when replaceColumns is true.

,

includeIfNotExistsOption (boolean, optional):

If true, IF NOT EXISTS option will be added to the CREATE TABLE ... statement in the generrated DDL. Please note that this parameter value has no effect on the relative CREATE TABLE ... statement, if generated DDL uses custom DDL. Must not be specified when replaceColumns is true.

,

replaceColumns (boolean, optional):

If true, an ALTER TABLE ... REPLACE COLUMNS will be generated

}

{
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "businessObjectFormatUsage": "string",
  "businessObjectFormatFileType": "string",
  "businessObjectFormatVersion": 0,
  "outputFormat": "HIVE_13_DDL",
  "tableName": "string",
  "customDdlName": "string",
  "includeDropTableStatement": true,
  "includeIfNotExistsOption": true,
  "replaceColumns": true
}

Click to set as parameter value

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectFormatDdlRequest>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <businessObjectFormatUsage>string</businessObjectFormatUsage>
     <businessObjectFormatFileType>string</businessObjectFormatFileType>
     <businessObjectFormatVersion>0</businessObjectFormatVersion>
     <outputFormat>HIVE_13_DDL</outputFormat>
     <tableName>string</tableName>
     <customDdlName>string</customDdlName>
     <includeDropTableStatement>true</includeDropTableStatement>
     <includeIfNotExistsOption>true</includeIfNotExistsOption>
     <replaceColumns>true</replaceColumns>
</businessObjectFormatDdlRequest>

Click to set as parameter value

Response (Status 200)

businessObjectFormatDdl {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The numeric version of a Business Object Format. If not supplied, the latest version will be used

,

outputFormat (string) = ['HIVE_13_DDL']

string
Enum:	"HIVE_13_DDL"

,

tableName (string):

The table name to be used in the generated DDL

,

customDdlName (string, optional):

he name of the Custom DDL. When Custom DDL name is specified, the Custom DDL which had previously been stored Business Object Format is returned instead of generated DDL. Must not be specified when replaceColumns is true

,

ddl (string):

A container for the generated DDL code which contains DDL for all the objects in the collection

}

{
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "businessObjectFormatUsage": "string",
  "businessObjectFormatFileType": "string",
  "businessObjectFormatVersion": 0,
  "outputFormat": "HIVE_13_DDL",
  "tableName": "string",
  "customDdlName": "string",
  "ddl": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectFormatDdl>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <businessObjectFormatUsage>string</businessObjectFormatUsage>
     <businessObjectFormatFileType>string</businessObjectFormatFileType>
     <businessObjectFormatVersion>0</businessObjectFormatVersion>
     <outputFormat>HIVE_13_DDL</outputFormat>
     <tableName>string</tableName>
     <customDdlName>string</customDdlName>
     <ddl>
    <![CDATA[
    string]]>
  </ddl>
</businessObjectFormatDdl>

Response Content Type

post /businessObjectFormats/generateDdlCollection

generateBusinessObjectFormatDdlCollection

Implementation Notes

Retrieves the DDL to initialize the specified type of the database system (e.g. Hive) by creating tables for a collection of business object formats.

Requires READ permission on ALL namespaces

Parameter (body): the business object format DDL collection request

Parameter content type:

businessObjectFormatDdlCollectionRequest {

businessObjectFormatDdlRequests (Array[businessObjectFormatDdlRequest], optional):

A container for multiple Business Object Format requests

}
businessObjectFormatDdlRequest {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The numeric version of a Business Object Format. If not supplied, the latest version will be used

,

outputFormat (string) = ['HIVE_13_DDL']

string
Enum:	"HIVE_13_DDL"

,

tableName (string):

The table name to be used in the generated DDL

,

customDdlName (string, optional):

The name of the Custom DDL. When Custom DDL name is specified, the Custom DDL which had previously been stored Business Object Format is returned instead of generated DDL. Must not be specified when replaceColumns is true

,

includeDropTableStatement (boolean, optional):

If true, drop table statement for existing table will be added to the generated DDL. Must not be specified when replaceColumns is true.

,

includeIfNotExistsOption (boolean, optional):

If true, IF NOT EXISTS option will be added to the CREATE TABLE ... statement in the generrated DDL. Please note that this parameter value has no effect on the relative CREATE TABLE ... statement, if generated DDL uses custom DDL. Must not be specified when replaceColumns is true.

,

replaceColumns (boolean, optional):

If true, an ALTER TABLE ... REPLACE COLUMNS will be generated

}

{
  "businessObjectFormatDdlRequests": [
    "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<businessObjectFormatDdlRequest>\n   <namespace>string</namespace>\n   <businessObjectDefinitionName>string</businessObjectDefinitionName>\n   <businessObjectFormatUsage>string</businessObjectFormatUsage>\n   <businessObjectFormatFileType>string</businessObjectFormatFileType>\n   <businessObjectFormatVersion>0</businessObjectFormatVersion>\n   <outputFormat>HIVE_13_DDL</outputFormat>\n   <tableName>string</tableName>\n   <customDdlName>string</customDdlName>\n   <includeDropTableStatement>true</includeDropTableStatement>\n   <includeIfNotExistsOption>true</includeIfNotExistsOption>\n   <replaceColumns>true</replaceColumns>\n</businessObjectFormatDdlRequest>\n"
  ]
}

Click to set as parameter value

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectFormatDdlCollectionRequest>
     <businessObjectFormatDdlRequests>
          <businessObjectFormatDdlRequest>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <outputFormat>HIVE_13_DDL</outputFormat>
               <tableName>string</tableName>
               <customDdlName>string</customDdlName>
               <includeDropTableStatement>true</includeDropTableStatement>
               <includeIfNotExistsOption>true</includeIfNotExistsOption>
               <replaceColumns>true</replaceColumns>
          </businessObjectFormatDdlRequest>
     </businessObjectFormatDdlRequests>
</businessObjectFormatDdlCollectionRequest>

Click to set as parameter value

Response (Status 200)

businessObjectFormatDdlCollectionResponse {

businessObjectFormatDdlResponses (Array[businessObjectFormatDdl], optional):

A container for the Business Object Format responses

,

ddlCollection (string):

A container for the combined DDL for all Business Object Formats in the collection

}
businessObjectFormatDdl {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The numeric version of a Business Object Format. If not supplied, the latest version will be used

,

outputFormat (string) = ['HIVE_13_DDL']

string
Enum:	"HIVE_13_DDL"

,

tableName (string):

The table name to be used in the generated DDL

,

customDdlName (string, optional):

he name of the Custom DDL. When Custom DDL name is specified, the Custom DDL which had previously been stored Business Object Format is returned instead of generated DDL. Must not be specified when replaceColumns is true

,

ddl (string):

A container for the generated DDL code which contains DDL for all the objects in the collection

}

{
  "businessObjectFormatDdlResponses": [
    "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<businessObjectFormatDdl>\n   <namespace>string</namespace>\n   <businessObjectDefinitionName>string</businessObjectDefinitionName>\n   <businessObjectFormatUsage>string</businessObjectFormatUsage>\n   <businessObjectFormatFileType>string</businessObjectFormatFileType>\n   <businessObjectFormatVersion>0</businessObjectFormatVersion>\n   <outputFormat>HIVE_13_DDL</outputFormat>\n   <tableName>string</tableName>\n   <customDdlName>string</customDdlName>\n   <ddl><![CDATA[string]]></ddl>\n</businessObjectFormatDdl>\n"
  ],
  "ddlCollection": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectFormatDdlCollectionResponse>
     <businessObjectFormatDdlResponses>
          <businessObjectFormatDdl>
               <namespace>string</namespace>
               <businessObjectDefinitionName>string</businessObjectDefinitionName>
               <businessObjectFormatUsage>string</businessObjectFormatUsage>
               <businessObjectFormatFileType>string</businessObjectFormatFileType>
               <businessObjectFormatVersion>0</businessObjectFormatVersion>
               <outputFormat>HIVE_13_DDL</outputFormat>
               <tableName>string</tableName>
               <customDdlName>string</customDdlName>
               <ddl>
        <![CDATA[
        string]]>
      </ddl>
          </businessObjectFormatDdl>
     </businessObjectFormatDdlResponses>
     <ddlCollection>string</ddlCollection>
</businessObjectFormatDdlCollectionResponse>

Response Content Type

get /businessObjectFormats/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}

getBusinessObjectFormats

Implementation Notes

Gets a list of business object formats for the specified business object definition name.

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace code	path	string
businessObjectDefinitionName	the business object definition name	path	string
latestBusinessObjectFormatVersion		query	boolean

Response (Status 200)

businessObjectFormatKeys {

businessObjectFormatKeys (Array[businessObjectFormatKey], optional)

}
businessObjectFormatKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The numeric version of a Business Object Format. Each time a format is registered, the new version will be the previous version

+ 1

}

{
  "businessObjectFormatKeys": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectFormatKeys>
     <businessObjectFormatKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
     </businessObjectFormatKey>
</businessObjectFormatKeys>

Response Content Type

get /businessObjectFormats/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}

getBusinessObjectFormat

Implementation Notes

Gets an existing business object format by alternate key.

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace code	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	query	integer

Response (Status 200)

businessObjectFormat {

id (integer, optional):

The internal identifier that uniquely identifies a Business Object Format

,

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The numeric version of a Business Object Format. Each time a format is registered, the new version will be the previous version

+ 1

,

latestVersion (boolean, optional):

A Y/N flag that shows whether this instance of format is the latest or not. Once a new version of format is registered, any previous versions will no longer be the latest

,

partitionKey (string):

The partition key for this Business Object Format

,

description (string, optional):

Description of the Business Object Format

,

attributes (Array[attribute], optional):

Custom user-defined metadata associated with this Business Object Format. "name" is the attribute name (i.e. the key) and "value" is the attribute value.

,

attributeDefinitions (Array[attributeDefinition], optional):

List of attribute definitions (for storage of custom user-defined metadata with objects) which are required to be specified when registering Business Object Data against this format. This list will define which metadata must be specified, but additional metadata can still be registered which is not specified in this list. The metadata (attributes) will allow applications to store custom data with registered data for use by consumers of the data

,

schema (schema, optional):

The schema associated with this Business Object Format

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}
attributeDefinition {

name (string):

Name of an Attribute that will be required when registering a Business Object Data of this Business Object Format

,

publish (boolean, optional):

              If true, this business object data attribute will be published in notification messages

}
schema {

columns (Array[schemaColumn], optional):

A container for Schema Columns that are present in data file(s) for this Business Object Format. Required when Schema is present

,

partitions (Array[schemaColumn], optional):

A container for partition columns in a specific schema. A schema might have zero, one or more partition columns. If a partition column is present in the data file(s), it should also be listed as a regular column in the schema with all column information matching (case sensitive)

,

nullValue (string, optional):

The string to use for the null value (e.g. "\\N"). Please note that a null value is allowed to be a whitespace character. XML escaping should be used when specifying non-ASCII characters. Note: when passing in an empty String, the response XML will return a NULL value (i.e. the tag will be absent). Generate DDL calls will show the correct empty String value wrapped in single-quotes. Required when Schema is present

,

delimiter (string, optional):

The field delimiter (e.g. "|"). Please note that a field delimiter is allowed to be a whitespace character. XML escaping should be used when specifying non-ASCII characters

,

escapeCharacter (string, optional):

The escape character (e.g. "\\"). XML escaping should be used when specifying non-ASCII characters.

,

partitionKeyGroup (string, optional):

The partition key group that this schema's partition or sub-partition key belongs to. This value will be used to identify the ordered set of Expected Partition Values when determining Business Object Data Availability or generating DDL using partition value ranges. A Partition Key Group value is required in the Business Object Format in order to use partition value ranges with the Availability and DDL services

}
schemaColumn {

name (string):

The name of the schema column. Required when Column is present

,

type (string):

The data type of the schema column. Required when Column is present

,

size (string, optional):

The column size. This is a string value since, for "NUMERIC" and "DECIMAL" data types, we should be able to specify both the maximum number of digits (p) that are present in the number and the maximum number of decimal places (s) as a "p,s" string. Required when Column is present

,

required (boolean, optional):

Values true|false. If true, a value isis required for the column (not nullable)

,

defaultValue (string, optional):

Default value for the column

,

description (string, optional):

Description of the column

}

{
  "id": 0,
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "businessObjectFormatUsage": "string",
  "businessObjectFormatFileType": "string",
  "businessObjectFormatVersion": 0,
  "latestVersion": true,
  "partitionKey": "string",
  "description": "string",
  "attributes": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "attributeDefinitions": [
    {
      "name": "string",
      "publish": true
    }
  ],
  "schema": {
    "columns": [
      {
        "name": "string",
        "type": "string",
        "size": "string",
        "required": true,
        "defaultValue": "string",
        "description": "string"
      }
    ],
    "partitions": [
      {
        "name": "string",
        "type": "string",
        "size": "string",
        "required": true,
        "defaultValue": "string",
        "description": "string"
      }
    ],
    "nullValue": "string",
    "delimiter": "string",
    "escapeCharacter": "string",
    "partitionKeyGroup": "string"
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectFormat>
     <id>0</id>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <businessObjectFormatUsage>string</businessObjectFormatUsage>
     <businessObjectFormatFileType>string</businessObjectFormatFileType>
     <businessObjectFormatVersion>0</businessObjectFormatVersion>
     <latestVersion>true</latestVersion>
     <partitionKey>string</partitionKey>
     <description>string</description>
     <attributes>
          <attribute>
               <name>string</name>
               <value>string</value>
          </attribute>
     </attributes>
     <attributeDefinitions>
          <attributeDefinition>
               <name>string</name>
               <publish>true</publish>
          </attributeDefinition>
     </attributeDefinitions>
     <schema>
          <columns>
               <column>
                    <name>string</name>
                    <type>string</type>
                    <size>string</size>
                    <required>true</required>
                    <defaultValue>string</defaultValue>
                    <description>string</description>
               </column>
          </columns>
          <partitions>
               <column>
                    <name>string</name>
                    <type>string</type>
                    <size>string</size>
                    <required>true</required>
                    <defaultValue>string</defaultValue>
                    <description>string</description>
               </column>
          </partitions>
          <nullValue>string</nullValue>
          <delimiter>string</delimiter>
          <escapeCharacter>string</escapeCharacter>
          <partitionKeyGroup>string</partitionKeyGroup>
     </schema>
</businessObjectFormat>

Response Content Type

delete /businessObjectFormats/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}

deleteBusinessObjectFormat

Implementation Notes

Deletes an existing business format.

Requires WRITE permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace code	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer

Response (Status 200)

businessObjectFormat {

id (integer, optional):

The internal identifier that uniquely identifies a Business Object Format

,

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The numeric version of a Business Object Format. Each time a format is registered, the new version will be the previous version

+ 1

,

latestVersion (boolean, optional):

A Y/N flag that shows whether this instance of format is the latest or not. Once a new version of format is registered, any previous versions will no longer be the latest

,

partitionKey (string):

The partition key for this Business Object Format

,

description (string, optional):

Description of the Business Object Format

,

attributes (Array[attribute], optional):

Custom user-defined metadata associated with this Business Object Format. "name" is the attribute name (i.e. the key) and "value" is the attribute value.

,

attributeDefinitions (Array[attributeDefinition], optional):

List of attribute definitions (for storage of custom user-defined metadata with objects) which are required to be specified when registering Business Object Data against this format. This list will define which metadata must be specified, but additional metadata can still be registered which is not specified in this list. The metadata (attributes) will allow applications to store custom data with registered data for use by consumers of the data

,

schema (schema, optional):

The schema associated with this Business Object Format

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}
attributeDefinition {

name (string):

Name of an Attribute that will be required when registering a Business Object Data of this Business Object Format

,

publish (boolean, optional):

              If true, this business object data attribute will be published in notification messages

}
schema {

columns (Array[schemaColumn], optional):

A container for Schema Columns that are present in data file(s) for this Business Object Format. Required when Schema is present

,

partitions (Array[schemaColumn], optional):

A container for partition columns in a specific schema. A schema might have zero, one or more partition columns. If a partition column is present in the data file(s), it should also be listed as a regular column in the schema with all column information matching (case sensitive)

,

nullValue (string, optional):

The string to use for the null value (e.g. "\\N"). Please note that a null value is allowed to be a whitespace character. XML escaping should be used when specifying non-ASCII characters. Note: when passing in an empty String, the response XML will return a NULL value (i.e. the tag will be absent). Generate DDL calls will show the correct empty String value wrapped in single-quotes. Required when Schema is present

,

delimiter (string, optional):

The field delimiter (e.g. "|"). Please note that a field delimiter is allowed to be a whitespace character. XML escaping should be used when specifying non-ASCII characters

,

escapeCharacter (string, optional):

The escape character (e.g. "\\"). XML escaping should be used when specifying non-ASCII characters.

,

partitionKeyGroup (string, optional):

The partition key group that this schema's partition or sub-partition key belongs to. This value will be used to identify the ordered set of Expected Partition Values when determining Business Object Data Availability or generating DDL using partition value ranges. A Partition Key Group value is required in the Business Object Format in order to use partition value ranges with the Availability and DDL services

}
schemaColumn {

name (string):

The name of the schema column. Required when Column is present

,

type (string):

The data type of the schema column. Required when Column is present

,

size (string, optional):

The column size. This is a string value since, for "NUMERIC" and "DECIMAL" data types, we should be able to specify both the maximum number of digits (p) that are present in the number and the maximum number of decimal places (s) as a "p,s" string. Required when Column is present

,

required (boolean, optional):

Values true|false. If true, a value isis required for the column (not nullable)

,

defaultValue (string, optional):

Default value for the column

,

description (string, optional):

Description of the column

}

{
  "id": 0,
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "businessObjectFormatUsage": "string",
  "businessObjectFormatFileType": "string",
  "businessObjectFormatVersion": 0,
  "latestVersion": true,
  "partitionKey": "string",
  "description": "string",
  "attributes": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "attributeDefinitions": [
    {
      "name": "string",
      "publish": true
    }
  ],
  "schema": {
    "columns": [
      {
        "name": "string",
        "type": "string",
        "size": "string",
        "required": true,
        "defaultValue": "string",
        "description": "string"
      }
    ],
    "partitions": [
      {
        "name": "string",
        "type": "string",
        "size": "string",
        "required": true,
        "defaultValue": "string",
        "description": "string"
      }
    ],
    "nullValue": "string",
    "delimiter": "string",
    "escapeCharacter": "string",
    "partitionKeyGroup": "string"
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectFormat>
     <id>0</id>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <businessObjectFormatUsage>string</businessObjectFormatUsage>
     <businessObjectFormatFileType>string</businessObjectFormatFileType>
     <businessObjectFormatVersion>0</businessObjectFormatVersion>
     <latestVersion>true</latestVersion>
     <partitionKey>string</partitionKey>
     <description>string</description>
     <attributes>
          <attribute>
               <name>string</name>
               <value>string</value>
          </attribute>
     </attributes>
     <attributeDefinitions>
          <attributeDefinition>
               <name>string</name>
               <publish>true</publish>
          </attributeDefinition>
     </attributeDefinitions>
     <schema>
          <columns>
               <column>
                    <name>string</name>
                    <type>string</type>
                    <size>string</size>
                    <required>true</required>
                    <defaultValue>string</defaultValue>
                    <description>string</description>
               </column>
          </columns>
          <partitions>
               <column>
                    <name>string</name>
                    <type>string</type>
                    <size>string</size>
                    <required>true</required>
                    <defaultValue>string</defaultValue>
                    <description>string</description>
               </column>
          </partitions>
          <nullValue>string</nullValue>
          <delimiter>string</delimiter>
          <escapeCharacter>string</escapeCharacter>
          <partitionKeyGroup>string</partitionKeyGroup>
     </schema>
</businessObjectFormat>

Response Content Type

put /businessObjectFormats/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}

updateBusinessObjectFormat

Implementation Notes

Updates an existing business object format by alternate key.

Requires WRITE permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace code	path	string
businessObjectDefinitionName		the business object definition name	path	string
businessObjectFormatUsage		the business object format usage	path	string
businessObjectFormatFileType		the business object format file type	path	string
businessObjectFormatVersion		the business object format version	path	integer
businessObjectFormatUpdateRequest: the information needed to update the business object format	Parameter content type: Model JSON Schema XML Example businessObjectFormatUpdateRequest { description (string, optional): Description of the Business Object Format , attributes (Array[attribute], optional): Custom user-defined metadata associated with this Business Object Format. "name" is the attribute name (i.e. the key) and "value" is the attribute value. , schema (schema, optional): The schema associated with this Business Object Format } attribute { name (string): Attribute key , value (string, optional): Attribute value } schema { columns (Array[schemaColumn], optional): A container for Schema Columns that are present in data file(s) for this Business Object Format. Required when Schema is present , partitions (Array[schemaColumn], optional): A container for partition columns in a specific schema. A schema might have zero, one or more partition columns. If a partition column is present in the data file(s), it should also be listed as a regular column in the schema with all column information matching (case sensitive) , nullValue (string, optional): The string to use for the null value (e.g. "\\N"). Please note that a null value is allowed to be a whitespace character. XML escaping should be used when specifying non-ASCII characters. Note: when passing in an empty String, the response XML will return a NULL value (i.e. the tag will be absent). Generate DDL calls will show the correct empty String value wrapped in single-quotes. Required when Schema is present , delimiter (string, optional): The field delimiter (e.g. "\|"). Please note that a field delimiter is allowed to be a whitespace character. XML escaping should be used when specifying non-ASCII characters , escapeCharacter (string, optional): The escape character (e.g. "\\"). XML escaping should be used when specifying non-ASCII characters. , partitionKeyGroup (string, optional): The partition key group that this schema's partition or sub-partition key belongs to. This value will be used to identify the ordered set of Expected Partition Values when determining Business Object Data Availability or generating DDL using partition value ranges. A Partition Key Group value is required in the Business Object Format in order to use partition value ranges with the Availability and DDL services } schemaColumn { name (string): The name of the schema column. Required when Column is present , type (string): The data type of the schema column. Required when Column is present , size (string, optional): The column size. This is a string value since, for "NUMERIC" and "DECIMAL" data types, we should be able to specify both the maximum number of digits (p) that are present in the number and the maximum number of decimal places (s) as a "p,s" string. Required when Column is present , required (boolean, optional): Values true\|false. If true, a value isis required for the column (not nullable) , defaultValue (string, optional): Default value for the column , description (string, optional): Description of the column } `{ "description": "string", "attributes": [ { "name": "string", "value": "string" } ], "schema": { "columns": [ { "name": "string", "type": "string", "size": "string", "required": true, "defaultValue": "string", "description": "string" } ], "partitions": [ { "name": "string", "type": "string", "size": "string", "required": true, "defaultValue": "string", "description": "string" } ], "nullValue": "string", "delimiter": "string", "escapeCharacter": "string", "partitionKeyGroup": "string" } }` Click to set as parameter value <?xml version="1.0" encoding="UTF-8"?> <businessObjectFormatUpdateRequest> <description>string</description> <attributes> <attribute> <name>string</name> <value>string</value> </attribute> </attributes> <schema> <columns> <column> <name>string</name> <type>string</type> <size>string</size> <required>true</required> <defaultValue>string</defaultValue> <description>string</description> </column> </columns> <partitions> <column> <name>string</name> <type>string</type> <size>string</size> <required>true</required> <defaultValue>string</defaultValue> <description>string</description> </column> </partitions> <nullValue>string</nullValue> <delimiter>string</delimiter> <escapeCharacter>string</escapeCharacter> <partitionKeyGroup>string</partitionKeyGroup> </schema> </businessObjectFormatUpdateRequest> Click to set as parameter value

Response (Status 200)

businessObjectFormat {

id (integer, optional):

The internal identifier that uniquely identifies a Business Object Format

,

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The numeric version of a Business Object Format. Each time a format is registered, the new version will be the previous version

+ 1

,

latestVersion (boolean, optional):

A Y/N flag that shows whether this instance of format is the latest or not. Once a new version of format is registered, any previous versions will no longer be the latest

,

partitionKey (string):

The partition key for this Business Object Format

,

description (string, optional):

Description of the Business Object Format

,

attributes (Array[attribute], optional):

Custom user-defined metadata associated with this Business Object Format. "name" is the attribute name (i.e. the key) and "value" is the attribute value.

,

attributeDefinitions (Array[attributeDefinition], optional):

List of attribute definitions (for storage of custom user-defined metadata with objects) which are required to be specified when registering Business Object Data against this format. This list will define which metadata must be specified, but additional metadata can still be registered which is not specified in this list. The metadata (attributes) will allow applications to store custom data with registered data for use by consumers of the data

,

schema (schema, optional):

The schema associated with this Business Object Format

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}
attributeDefinition {

name (string):

Name of an Attribute that will be required when registering a Business Object Data of this Business Object Format

,

publish (boolean, optional):

              If true, this business object data attribute will be published in notification messages

}
schema {

columns (Array[schemaColumn], optional):

A container for Schema Columns that are present in data file(s) for this Business Object Format. Required when Schema is present

,

partitions (Array[schemaColumn], optional):

A container for partition columns in a specific schema. A schema might have zero, one or more partition columns. If a partition column is present in the data file(s), it should also be listed as a regular column in the schema with all column information matching (case sensitive)

,

nullValue (string, optional):

The string to use for the null value (e.g. "\\N"). Please note that a null value is allowed to be a whitespace character. XML escaping should be used when specifying non-ASCII characters. Note: when passing in an empty String, the response XML will return a NULL value (i.e. the tag will be absent). Generate DDL calls will show the correct empty String value wrapped in single-quotes. Required when Schema is present

,

delimiter (string, optional):

The field delimiter (e.g. "|"). Please note that a field delimiter is allowed to be a whitespace character. XML escaping should be used when specifying non-ASCII characters

,

escapeCharacter (string, optional):

The escape character (e.g. "\\"). XML escaping should be used when specifying non-ASCII characters.

,

partitionKeyGroup (string, optional):

The partition key group that this schema's partition or sub-partition key belongs to. This value will be used to identify the ordered set of Expected Partition Values when determining Business Object Data Availability or generating DDL using partition value ranges. A Partition Key Group value is required in the Business Object Format in order to use partition value ranges with the Availability and DDL services

}
schemaColumn {

name (string):

The name of the schema column. Required when Column is present

,

type (string):

The data type of the schema column. Required when Column is present

,

size (string, optional):

The column size. This is a string value since, for "NUMERIC" and "DECIMAL" data types, we should be able to specify both the maximum number of digits (p) that are present in the number and the maximum number of decimal places (s) as a "p,s" string. Required when Column is present

,

required (boolean, optional):

Values true|false. If true, a value isis required for the column (not nullable)

,

defaultValue (string, optional):

Default value for the column

,

description (string, optional):

Description of the column

}

{
  "id": 0,
  "namespace": "string",
  "businessObjectDefinitionName": "string",
  "businessObjectFormatUsage": "string",
  "businessObjectFormatFileType": "string",
  "businessObjectFormatVersion": 0,
  "latestVersion": true,
  "partitionKey": "string",
  "description": "string",
  "attributes": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "attributeDefinitions": [
    {
      "name": "string",
      "publish": true
    }
  ],
  "schema": {
    "columns": [
      {
        "name": "string",
        "type": "string",
        "size": "string",
        "required": true,
        "defaultValue": "string",
        "description": "string"
      }
    ],
    "partitions": [
      {
        "name": "string",
        "type": "string",
        "size": "string",
        "required": true,
        "defaultValue": "string",
        "description": "string"
      }
    ],
    "nullValue": "string",
    "delimiter": "string",
    "escapeCharacter": "string",
    "partitionKeyGroup": "string"
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<businessObjectFormat>
     <id>0</id>
     <namespace>string</namespace>
     <businessObjectDefinitionName>string</businessObjectDefinitionName>
     <businessObjectFormatUsage>string</businessObjectFormatUsage>
     <businessObjectFormatFileType>string</businessObjectFormatFileType>
     <businessObjectFormatVersion>0</businessObjectFormatVersion>
     <latestVersion>true</latestVersion>
     <partitionKey>string</partitionKey>
     <description>string</description>
     <attributes>
          <attribute>
               <name>string</name>
               <value>string</value>
          </attribute>
     </attributes>
     <attributeDefinitions>
          <attributeDefinition>
               <name>string</name>
               <publish>true</publish>
          </attributeDefinition>
     </attributeDefinitions>
     <schema>
          <columns>
               <column>
                    <name>string</name>
                    <type>string</type>
                    <size>string</size>
                    <required>true</required>
                    <defaultValue>string</defaultValue>
                    <description>string</description>
               </column>
          </columns>
          <partitions>
               <column>
                    <name>string</name>
                    <type>string</type>
                    <size>string</size>
                    <required>true</required>
                    <defaultValue>string</defaultValue>
                    <description>string</description>
               </column>
          </partitions>
          <nullValue>string</nullValue>
          <delimiter>string</delimiter>
          <escapeCharacter>string</escapeCharacter>
          <partitionKeyGroup>string</partitionKeyGroup>
     </schema>
</businessObjectFormat>

Response Content Type

Current User

Custom DDL

post /customDdls

createCustomDdl

Implementation Notes

Creates a new custom DDL.

Requires WRITE permission on namespace

Parameter (body): the information needed to create a custom DDL
Parameter content type: Model JSON Schema XML Example customDdlCreateRequest { customDdlKey (customDdlKey): Values that uniquely identify a Custom DDL , ddl (string): A container for the custom DDL code } customDdlKey { namespace (string): The Namespace to which a Business Object Format is related , businessObjectDefinitionName (string): The name of the Business Object Definition to which a Business Object Format is related , businessObjectFormatUsage (string): The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions , businessObjectFormatFileType (string): A File Type known to the system that describes the file type of data stored under a Business Object Format , businessObjectFormatVersion (integer, optional): The numeric version of a Business Object Format , customDdlName (string): A user-defined descriptive name for this Custom DDL } `{ "customDdlKey": { "namespace": "string", "businessObjectDefinitionName": "string", "businessObjectFormatUsage": "string", "businessObjectFormatFileType": "string", "businessObjectFormatVersion": 0, "customDdlName": "string" }, "ddl": "string" }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <customDdlCreateRequest> <customDdlKey> <namespace>string</namespace> <businessObjectDefinitionName>string</businessObjectDefinitionName> <businessObjectFormatUsage>string</businessObjectFormatUsage> <businessObjectFormatFileType>string</businessObjectFormatFileType> <businessObjectFormatVersion>0</businessObjectFormatVersion> <customDdlName>string</customDdlName> </customDdlKey> <ddl> <![CDATA[ string]]> </ddl> </customDdlCreateRequest>` Click to set as parameter value

Response (Status 200)

customDdl {

id (integer, optional):

The internal Id that uniquely references the newly created custom DDL

,

customDdlKey (customDdlKey):

Values that uniquely identify a Custom DDL

,

ddl (string):

A container for the custom DDL code

}
customDdlKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The numeric version of a Business Object Format

,

customDdlName (string):

A user-defined descriptive name for this Custom DDL

}

{
  "id": 0,
  "customDdlKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "customDdlName": "string"
  },
  "ddl": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<customDdl>
     <id>0</id>
     <customDdlKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <customDdlName>string</customDdlName>
     </customDdlKey>
     <ddl>
    <![CDATA[
    string]]>
  </ddl>
</customDdl>

Response Content Type

get /customDdls/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}

getCustomDdls

Implementation Notes

Gets a list of keys for all existing custom DDLs for a specific business object format.

Requires READ permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer

Response (Status 200)

customDdlKeys {

customDdlKeys (Array[customDdlKey], optional)

}
customDdlKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The numeric version of a Business Object Format

,

customDdlName (string):

A user-defined descriptive name for this Custom DDL

}

{
  "customDdlKeys": [
    {
      "namespace": "string",
      "businessObjectDefinitionName": "string",
      "businessObjectFormatUsage": "string",
      "businessObjectFormatFileType": "string",
      "businessObjectFormatVersion": 0,
      "customDdlName": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<customDdlKeys>
     <customDdlKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <customDdlName>string</customDdlName>
     </customDdlKey>
</customDdlKeys>

Response Content Type

delete /customDdls/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/customDdlNames/{customDdlName}

deleteCustomDdl

Implementation Notes

Deletes an existing custom DDL.

Requires WRITE permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
customDdlName	the custom DDL name	path	string

Response (Status 200)

customDdl {

id (integer, optional):

The internal Id that uniquely references the newly created custom DDL

,

customDdlKey (customDdlKey):

Values that uniquely identify a Custom DDL

,

ddl (string):

A container for the custom DDL code

}
customDdlKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The numeric version of a Business Object Format

,

customDdlName (string):

A user-defined descriptive name for this Custom DDL

}

{
  "id": 0,
  "customDdlKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "customDdlName": "string"
  },
  "ddl": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<customDdl>
     <id>0</id>
     <customDdlKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <customDdlName>string</customDdlName>
     </customDdlKey>
     <ddl>
    <![CDATA[
    string]]>
  </ddl>
</customDdl>

Response Content Type

get /customDdls/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/customDdlNames/{customDdlName}

getCustomDdl

Implementation Notes

Gets an existing custom DDL.

Requires READ permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
customDdlName	the custom DDL name	path	string

Response (Status 200)

customDdl {

id (integer, optional):

The internal Id that uniquely references the newly created custom DDL

,

customDdlKey (customDdlKey):

Values that uniquely identify a Custom DDL

,

ddl (string):

A container for the custom DDL code

}
customDdlKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The numeric version of a Business Object Format

,

customDdlName (string):

A user-defined descriptive name for this Custom DDL

}

{
  "id": 0,
  "customDdlKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "customDdlName": "string"
  },
  "ddl": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<customDdl>
     <id>0</id>
     <customDdlKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <customDdlName>string</customDdlName>
     </customDdlKey>
     <ddl>
    <![CDATA[
    string]]>
  </ddl>
</customDdl>

Response Content Type

put /customDdls/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/customDdlNames/{customDdlName}

updateCustomDdl

Implementation Notes

Updates an existing custom DDL.

Requires WRITE permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace	path	string
businessObjectDefinitionName		the business object definition name	path	string
businessObjectFormatUsage		the business object format usage	path	string
businessObjectFormatFileType		the business object format file type	path	string
businessObjectFormatVersion		the business object format version	path	integer
customDdlName		the custom DDL name	path	string
customDdlUpdateRequest: the request information needed to update the custom DDL	Parameter content type: Model JSON Schema XML Example customDdlUpdateRequest { ddl (string): A container for the custom DDL code } `{ "ddl": "string" }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <customDdlUpdateRequest> <ddl> <![CDATA[ string]]> </ddl> </customDdlUpdateRequest>` Click to set as parameter value

Response (Status 200)

customDdl {

id (integer, optional):

The internal Id that uniquely references the newly created custom DDL

,

customDdlKey (customDdlKey):

Values that uniquely identify a Custom DDL

,

ddl (string):

A container for the custom DDL code

}
customDdlKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The numeric version of a Business Object Format

,

customDdlName (string):

A user-defined descriptive name for this Custom DDL

}

{
  "id": 0,
  "customDdlKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "customDdlName": "string"
  },
  "ddl": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<customDdl>
     <id>0</id>
     <customDdlKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <customDdlName>string</customDdlName>
     </customDdlKey>
     <ddl>
    <![CDATA[
    string]]>
  </ddl>
</customDdl>

Response Content Type

DataProvider

- get /dataProviders
  - getDataProviders
  Implementation Notes
  
  Gets a list of data provider keys for all data providers defined in the system.
  Response (Status 200)
  Model
  
  JSON Schema
  
  XML Example
  
  dataProviderKeys {
  dataProviderKeys (Array[dataProviderKey], optional)
  }
  dataProviderKey {
  dataProviderName (string)
  }
  
  { "dataProviderKeys": [ { "dataProviderName": "string" } ] }
  
  <?xml version="1.0" encoding="UTF-8"?> <dataProviderKeys> <dataProviderKey> <dataProviderName>string</dataProviderName> </dataProviderKey> </dataProviderKeys>
  Response Content Type
  
  Hide Response
  Curl
  
  Request URL
  
  Response Body
  
  Response Code

EMR

post /emrClusters

createEmrCluster

Implementation Notes

Creates a new EMR cluster.

Requires EXECUTE permission on namespace

Parameter (body): the information needed to create the EMR cluster.
Parameter content type: Model JSON Schema XML Example emrClusterCreateRequest { namespace (string), emrClusterDefinitionName (string), emrClusterName (string), dryRun (boolean, optional), emrClusterDefinitionOverride (emrClusterDefinition, optional) } emrClusterDefinition { sshKeyPairName (string, optional): The name of the Amazon EC2 key pair to set as the connection credential , subnetId (string, optional): A comma separated list of Amazon VPC subnets. When multiple subnets are specified, the subnet in the AZ with the best price will be used. When multiple subnets belong to the same AZ, the subnet with the largest amount of available IP's will be used. Cross-VPC access in PROD will only accept internal/emr subnets at this time. , logBucket (string, optional): Amazon S3 bucket to receive log files , keepAlive (boolean, optional): Launch a cluster that continues running even after completing all its steps , visibleToAll (boolean, optional): Makes the instances in an existing cluster visible to all IAM users , terminationProtection (boolean, optional): Launch the cluster with termination protection enabled , encryptionEnabled (boolean, optional): Volume level encryption for the disks (using custom scripts). Encryption is not supported for AMI versions lower than 3.1.0 , serviceIamRole (string, optional): Launches the Amazon EMR service with the specified IAM role , ec2NodeIamProfileName (string, optional): Launches the EC2 instances of a cluster with the specified IAM role , amiVersion (string, optional): Specify the version of the AMI to use , releaseLabel (string, optional): The release label. Available from 4.x , hadoopVersion (string, optional): Specify the version of Hadoop to install , hiveVersion (string, optional): The Hive version to load , pigVersion (string, optional): The Pig version to load , installOozie (boolean, optional), customBootstrapActionMaster (Array[scriptDefinition], optional): Bootstrapping scripts that are executed only on the Master node , customBootstrapActionAll (Array[scriptDefinition], optional): Bootstrapping scripts that are executed on all the nodes , additionalInfo (string, optional): Specifies additional information during cluster creation , instanceDefinitions (instanceDefinitions, optional): Instance Group Definitions , nodeTags (Array[nodeTag], optional): Custom tags to be applied on the EC2 nodes , supportedProduct (string, optional): Installs third-party software on an Amazon EMR cluster , applications (Array[emrClusterDefinitionApplication], optional): List of applications , configurations (Array[emrClusterDefinitionConfiguration], optional): List of configurations , daemonConfigurations (Array[parameter], optional): Predefined bootstrap action to configure hadoop daemons , hadoopConfigurations (Array[string], optional): Predefined bootstrap action to specify hadoop configurations , hadoopJarSteps (Array[hadoopJarStep], optional): Hadoop jar steps that are added, to be executed once the cluster is started , additionalMasterSecurityGroups (Array[string], optional): List of additional master node security groups. The security group defined by the configuration value emr.herd.support.security.group will automatically be added whether this list is specified or not , additionalSlaveSecurityGroups (Array[string], optional): List of additional slave node security groups } scriptDefinition { scriptName (string), scriptLocation (string), scriptArguments (Array[string], optional) } instanceDefinitions { masterInstances (masterInstanceDefinition, optional), coreInstances (instanceDefinition, optional), taskInstances (instanceDefinition, optional) } nodeTag { tagName (string), tagValue (string) } emrClusterDefinitionApplication { name (string, optional): Application name , version (string, optional): Application version , args (Array[string], optional): List of arguments , additionalInfoList (Array[parameter], optional): List of additional info } emrClusterDefinitionConfiguration { classification (string, optional): The configuration classification , configurations (Array[emrClusterDefinitionConfiguration], optional): List of configurations , properties (Array[parameter], optional): List of properties } parameter { name (string): `Name of the parameter` , value (string, optional): `Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the application logs` } hadoopJarStep { stepName (string), jarLocation (string), mainClass (string, optional), scriptArguments (Array[string], optional), continueOnError (boolean, optional) } masterInstanceDefinition { instanceCount (integer, optional), instanceType (string), instanceSpotPrice (number, optional): The instance bid price, in USD. If not specified, uses on-demand , instanceMaxSearchPrice (number, optional): The maximum amount, in USD, to search for the best price. The best price search will only search for prices lower than this value. If a spot instance is selected by the search, this value will be the bid price , instanceOnDemandThreshold (number, optional): The amount, in USD, you are willing to pay over the lowest spot price for an on-demand instance. Use this to dynamically balance the cost vs. stability of your instances. If not specified, the search will not attempt to find an on-demand instance when a spot is found. This is the same behavior as when this parameter is set to $0. } instanceDefinition { instanceCount (integer, optional), instanceType (string), instanceSpotPrice (number, optional), instanceMaxSearchPrice (number, optional): The maximum amount, in USD, to search for the best price. The best price search will only search for prices lower than this value. If a spot instance is selected by the search, this value will be the bid price. , instanceOnDemandThreshold (number, optional): The amount, in USD, you are willing to pay over the lowest spot price for an on-demand instance. Use this to dynamically balance the cost vs. stability of your instances. If not specified, the search will not attempt to find an on-demand instance when a spot is found. This is the same behavior as when this parameter is set to $0. } { "namespace": "string", "emrClusterDefinitionName": "string", "emrClusterName": "string", "dryRun": true, "emrClusterDefinitionOverride": { "sshKeyPairName": "string", "subnetId": "string", "logBucket": "string", "keepAlive": true, "visibleToAll": true, "terminationProtection": true, "encryptionEnabled": true, "serviceIamRole": "string", "ec2NodeIamProfileName": "string", "amiVersion": "string", "releaseLabel": "string", "hadoopVersion": "string", "hiveVersion": "string", "pigVersion": "string", "installOozie": true, "customBootstrapActionMaster": [ { "scriptName": "string", "scriptLocation": "string", "scriptArguments": [ "string" ] } ], "customBootstrapActionAll": [ { "scriptName": "string", "scriptLocation": "string", "scriptArguments": [ "string" ] } ], "additionalInfo": "string", "instanceDefinitions": { "masterInstances": { "instanceCount": 0, "instanceType": "string", "instanceSpotPrice": 0, "instanceMaxSearchPrice": 0, "instanceOnDemandThreshold": 0 }, "coreInstances": { "instanceCount": 0, "instanceType": "string", "instanceSpotPrice": 0, "instanceMaxSearchPrice": 0, "instanceOnDemandThreshold": 0 }, "taskInstances": { "instanceCount": 0, "instanceType": "string", "instanceSpotPrice": 0, "instanceMaxSearchPrice": 0, "instanceOnDemandThreshold": 0 } }, "nodeTags": [ { "tagName": "string", "tagValue": "string" } ], "supportedProduct": "string", "applications": [ { "name": "string", "version": "string", "args": [ "string" ], "additionalInfoList": [ { "name": "string", "value": "string" } ] } ], "configurations": [ { "classification": "string", "configurations": [ {} ], "properties": [ { "name": "string", "value": "string" } ] } ], "daemonConfigurations": [ { "name": "string", "value": "string" } ], "hadoopConfigurations": [ "string" ], "hadoopJarSteps": [ { "stepName": "string", "jarLocation": "string", "mainClass": "string", "scriptArguments": [ "string" ], "continueOnError": true } ], "additionalMasterSecurityGroups": [ "string" ], "additionalSlaveSecurityGroups": [ "string" ] } } Click to set as parameter value <?xml version="1.0" encoding="UTF-8"?> <emrClusterCreateRequest> <namespace>string</namespace> <emrClusterDefinitionName>string</emrClusterDefinitionName> <emrClusterName>string</emrClusterName> <dryRun>true</dryRun> <emrClusterDefinitionOverride> <sshKeyPairName>string</sshKeyPairName> <subnetId>string</subnetId> <logBucket>string</logBucket> <keepAlive>true</keepAlive> <visibleToAll>true</visibleToAll> <terminationProtection>true</terminationProtection> <encryptionEnabled>true</encryptionEnabled> <serviceIamRole>string</serviceIamRole> <ec2NodeIamProfileName>string</ec2NodeIamProfileName> <amiVersion>string</amiVersion> <releaseLabel>string</releaseLabel> <hadoopVersion>string</hadoopVersion> <hiveVersion>string</hiveVersion> <pigVersion>string</pigVersion> <installOozie>true</installOozie> <customBootstrapActionMaster> <scriptDefinition> <scriptName>string</scriptName> <scriptLocation>string</scriptLocation> <scriptArguments> <argument>string</argument> </scriptArguments> </scriptDefinition> </customBootstrapActionMaster> <customBootstrapActionAll> <scriptDefinition> <scriptName>string</scriptName> <scriptLocation>string</scriptLocation> <scriptArguments> <argument>string</argument> </scriptArguments> </scriptDefinition> </customBootstrapActionAll> <additionalInfo>string</additionalInfo> <instanceDefinitions> <masterInstances> <instanceCount>0</instanceCount> <instanceType>string</instanceType> <instanceSpotPrice>0</instanceSpotPrice> <instanceMaxSearchPrice>0</instanceMaxSearchPrice> <instanceOnDemandThreshold>0</instanceOnDemandThreshold> </masterInstances> <coreInstances> <instanceCount>0</instanceCount> <instanceType>string</instanceType> <instanceSpotPrice>0</instanceSpotPrice> <instanceMaxSearchPrice>0</instanceMaxSearchPrice> <instanceOnDemandThreshold>0</instanceOnDemandThreshold> </coreInstances> <taskInstances> <instanceCount>0</instanceCount> <instanceType>string</instanceType> <instanceSpotPrice>0</instanceSpotPrice> <instanceMaxSearchPrice>0</instanceMaxSearchPrice> <instanceOnDemandThreshold>0</instanceOnDemandThreshold> </taskInstances> </instanceDefinitions> <nodeTags> <nodeTag> <tagName>string</tagName> <tagValue>string</tagValue> </nodeTag> </nodeTags> <supportedProduct>string</supportedProduct> <applications> <application> <name>string</name> <version>string</version> <args> <arg>string</arg> </args> <additionalInfoList> <additionalInfo> <name>string</name> <value>string</value> </additionalInfo> </additionalInfoList> </application> </applications> <configurations> <configuration> <classification>string</classification> <configurations> <configuration/> </configurations> <properties> <property> <name>string</name> <value>string</value> </property> </properties> </configuration> </configurations> <daemonConfigurations> <daemonParam> <name>string</name> <value>string</value> </daemonParam> </daemonConfigurations> <hadoopConfigurations/> <hadoopJarSteps> <hadoopJarStep> <stepName>string</stepName> <jarLocation>string</jarLocation> <mainClass>string</mainClass> <scriptArguments> <argument>string</argument> </scriptArguments> <continueOnError>true</continueOnError> </hadoopJarStep> </hadoopJarSteps> <additionalMasterSecurityGroups> <additionalMasterSecurityGroup>string</additionalMasterSecurityGroup> </additionalMasterSecurityGroups> <additionalSlaveSecurityGroups> <additionalSlaveSecurityGroup>string</additionalSlaveSecurityGroup> </additionalSlaveSecurityGroups> </emrClusterDefinitionOverride> </emrClusterCreateRequest> Click to set as parameter value

Response (Status 200)

emrCluster {

id (string, optional),

status (string, optional),

statusChangeReason (statusChangeReason, optional):

              The reason for the cluster status change.

,

statusTimeline (statusTimeline, optional):

              A timeline that represents the status of a cluster over the lifetime of the cluster.

,

namespace (string),

emrClusterDefinitionName (string),

emrClusterName (string),

activeStep (emrStep, optional),

step (emrStep, optional),

oozieWorkflowJobs (Array[oozieWorkflowJob], optional),

dryRun (boolean, optional),

emrClusterCreated (boolean, optional),

emrClusterDefinition (emrClusterDefinition, optional)

}
statusChangeReason {

code (string, optional):

              The programmatic code for the state change reason.

,

message (string, optional):

              The descriptive message for the state change reason.

}
statusTimeline {

creationTime (string, optional):

              The creation date and time of the cluster.

,

readyTime (string, optional):

              The date and time when the cluster was ready to execute steps.

,

endTime (string, optional):

              The date and time when the cluster was terminated.

}
emrStep {

id (string),

stepName (string),

jarLocation (string, optional),

mainClass (string, optional),

scriptArguments (Array[string], optional),

continueOnError (string, optional),

status (string)

}
oozieWorkflowJob {

id (string, optional),

namespace (string, optional),

emrClusterDefinitionName (string, optional),

emrClusterName (string, optional),

status (string, optional),

errorCode (string, optional),

errorMessage (string, optional),

startTime (string, optional),

endTime (string, optional),

workflowActions (Array[oozieWorkflowAction], optional),

emrClusterId (string, optional)

}
emrClusterDefinition {

sshKeyPairName (string, optional):

The name of the Amazon EC2 key pair to set as the connection credential

,

subnetId (string, optional):

A comma separated list of Amazon VPC subnets.

When multiple subnets are specified, the subnet in the AZ with the best price will be used.
When multiple subnets belong to the same AZ, the subnet with the largest amount of available IP's will be used.

Cross-VPC access in PROD will only accept internal/emr subnets at this time.

,

logBucket (string, optional):

Amazon S3 bucket to receive log files

,

keepAlive (boolean, optional):

Launch a cluster that continues running even after completing all its steps

,

visibleToAll (boolean, optional):

Makes the instances in an existing cluster visible to all IAM users

,

terminationProtection (boolean, optional):

Launch the cluster with termination protection enabled

,

encryptionEnabled (boolean, optional):

Volume level encryption for the disks (using custom scripts). Encryption is not supported for AMI versions lower than 3.1.0

,

serviceIamRole (string, optional):

Launches the Amazon EMR service with the specified IAM role

,

ec2NodeIamProfileName (string, optional):

Launches the EC2 instances of a cluster with the specified IAM role

,

amiVersion (string, optional):

Specify the version of the AMI to use

,

releaseLabel (string, optional):

The release label. Available from 4.x

,

hadoopVersion (string, optional):

Specify the version of Hadoop to install

,

hiveVersion (string, optional):

The Hive version to load

,

pigVersion (string, optional):

The Pig version to load

,

installOozie (boolean, optional),

customBootstrapActionMaster (Array[scriptDefinition], optional):

Bootstrapping scripts that are executed only on the Master node

,

customBootstrapActionAll (Array[scriptDefinition], optional):

Bootstrapping scripts that are executed on all the nodes

,

additionalInfo (string, optional):

Specifies additional information during cluster creation

,

instanceDefinitions (instanceDefinitions, optional):

Instance Group Definitions

,

nodeTags (Array[nodeTag], optional):

Custom tags to be applied on the EC2 nodes

,

supportedProduct (string, optional):

Installs third-party software on an Amazon EMR cluster

,

applications (Array[emrClusterDefinitionApplication], optional):

List of applications

,

configurations (Array[emrClusterDefinitionConfiguration], optional):

List of configurations

,

daemonConfigurations (Array[parameter], optional):

Predefined bootstrap action to configure hadoop daemons

,

hadoopConfigurations (Array[string], optional):

Predefined bootstrap action to specify hadoop configurations

,

hadoopJarSteps (Array[hadoopJarStep], optional):

Hadoop jar steps that are added, to be executed once the cluster is started

,

additionalMasterSecurityGroups (Array[string], optional):

List of additional master node security groups. The security group defined by the configuration value emr.herd.support.security.group will automatically be added whether this list is specified or not

,

additionalSlaveSecurityGroups (Array[string], optional):

List of additional slave node security groups

}
oozieWorkflowAction {

id (string, optional),

name (string, optional),

status (string, optional),

startTime (string, optional),

endTime (string, optional),

errorCode (string, optional),

errorMessage (string, optional)

}
scriptDefinition {

scriptName (string),

scriptLocation (string),

scriptArguments (Array[string], optional)

}
instanceDefinitions {

masterInstances (masterInstanceDefinition, optional),

coreInstances (instanceDefinition, optional),

taskInstances (instanceDefinition, optional)

}
nodeTag {

tagName (string),

tagValue (string)

}
emrClusterDefinitionApplication {

name (string, optional):

Application name

,

version (string, optional):

Application version

,

args (Array[string], optional):

List of arguments

,

additionalInfoList (Array[parameter], optional):

List of additional info

}
emrClusterDefinitionConfiguration {

classification (string, optional):

The configuration classification

,

configurations (Array[emrClusterDefinitionConfiguration], optional):

List of configurations

,

properties (Array[parameter], optional):

List of properties

}
parameter {

name (string):

              Name of the parameter

,

value (string, optional):

              Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the
              application logs

}
hadoopJarStep {

stepName (string),

jarLocation (string),

mainClass (string, optional),

scriptArguments (Array[string], optional),

continueOnError (boolean, optional)

}
masterInstanceDefinition {

instanceCount (integer, optional),

instanceType (string),

instanceSpotPrice (number, optional):

The instance bid price, in USD. If not specified, uses on-demand

,

instanceMaxSearchPrice (number, optional):

The maximum amount, in USD, to search for the best price. The best price search will only search for prices lower than this value. If a spot instance is selected by the search, this value will be the bid price

,

instanceOnDemandThreshold (number, optional):

The amount, in USD, you are willing to pay over the lowest spot price for an on-demand instance. Use this to dynamically balance the cost vs. stability of your instances.

If not specified, the search will not attempt to find an on-demand instance when a spot is found. This is the same behavior as when this parameter is set to $0.

}
instanceDefinition {

instanceCount (integer, optional),

instanceType (string),

instanceSpotPrice (number, optional),

instanceMaxSearchPrice (number, optional):

The maximum amount, in USD, to search for the best price. The best price search will only search for prices lower than this value. If a spot instance is selected by the search, this value will be the bid price.

,

instanceOnDemandThreshold (number, optional):

The amount, in USD, you are willing to pay over the lowest spot price for an on-demand instance. Use this to dynamically balance the cost vs. stability of your instances.

If not specified, the search will not attempt to find an on-demand instance when a spot is found. This is the same behavior as when this parameter is set to $0.

}

{
  "id": "string",
  "status": "string",
  "statusChangeReason": {
    "code": "string",
    "message": "string"
  },
  "statusTimeline": {
    "creationTime": "2017-04-29T14:40:26.939Z",
    "readyTime": "2017-04-29T14:40:26.939Z",
    "endTime": "2017-04-29T14:40:26.939Z"
  },
  "namespace": "string",
  "emrClusterDefinitionName": "string",
  "emrClusterName": "string",
  "activeStep": {
    "id": "string",
    "stepName": "string",
    "jarLocation": "string",
    "mainClass": "string",
    "scriptArguments": [
      "string"
    ],
    "continueOnError": "string",
    "status": "string"
  },
  "step": {
    "id": "string",
    "stepName": "string",
    "jarLocation": "string",
    "mainClass": "string",
    "scriptArguments": [
      "string"
    ],
    "continueOnError": "string",
    "status": "string"
  },
  "oozieWorkflowJobs": [
    "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<oozieWorkflowJob>\n   <id>string</id>\n   <namespace>string</namespace>\n   <emrClusterDefinitionName>string</emrClusterDefinitionName>\n   <emrClusterName>string</emrClusterName>\n   <status>string</status>\n   <errorCode>string</errorCode>\n   <errorMessage>string</errorMessage>\n   <startTime>2015-12-25T00:00:00.000-05:00</startTime>\n   <endTime>2015-12-25T00:00:00.000-05:00</endTime>\n   <workflowActions>\n      <workflowAction>\n         <id>string</id>\n         <name>string</name>\n         <status>string</status>\n         <startTime>2015-12-25T00:00:00.000-05:00</startTime>\n         <endTime>2015-12-25T00:00:00.000-05:00</endTime>\n         <errorCode>string</errorCode>\n         <errorMessage>string</errorMessage>\n      </workflowAction>\n   </workflowActions>\n   <emrClusterId>string</emrClusterId>\n</oozieWorkflowJob>\n"
  ],
  "dryRun": true,
  "emrClusterCreated": true,
  "emrClusterDefinition": {
    "sshKeyPairName": "string",
    "subnetId": "string",
    "logBucket": "string",
    "keepAlive": true,
    "visibleToAll": true,
    "terminationProtection": true,
    "encryptionEnabled": true,
    "serviceIamRole": "string",
    "ec2NodeIamProfileName": "string",
    "amiVersion": "string",
    "releaseLabel": "string",
    "hadoopVersion": "string",
    "hiveVersion": "string",
    "pigVersion": "string",
    "installOozie": true,
    "customBootstrapActionMaster": [
      {
        "scriptName": "string",
        "scriptLocation": "string",
        "scriptArguments": [
          "string"
        ]
      }
    ],
    "customBootstrapActionAll": [
      {
        "scriptName": "string",
        "scriptLocation": "string",
        "scriptArguments": [
          "string"
        ]
      }
    ],
    "additionalInfo": "string",
    "instanceDefinitions": {
      "masterInstances": {
        "instanceCount": 0,
        "instanceType": "string",
        "instanceSpotPrice": 0,
        "instanceMaxSearchPrice": 0,
        "instanceOnDemandThreshold": 0
      },
      "coreInstances": {
        "instanceCount": 0,
        "instanceType": "string",
        "instanceSpotPrice": 0,
        "instanceMaxSearchPrice": 0,
        "instanceOnDemandThreshold": 0
      },
      "taskInstances": {
        "instanceCount": 0,
        "instanceType": "string",
        "instanceSpotPrice": 0,
        "instanceMaxSearchPrice": 0,
        "instanceOnDemandThreshold": 0
      }
    },
    "nodeTags": [
      {
        "tagName": "string",
        "tagValue": "string"
      }
    ],
    "supportedProduct": "string",
    "applications": [
      {
        "name": "string",
        "version": "string",
        "args": [
          "string"
        ],
        "additionalInfoList": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "configurations": [
      {
        "classification": "string",
        "configurations": [
          {}
        ],
        "properties": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "daemonConfigurations": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "hadoopConfigurations": [
      "string"
    ],
    "hadoopJarSteps": [
      {
        "stepName": "string",
        "jarLocation": "string",
        "mainClass": "string",
        "scriptArguments": [
          "string"
        ],
        "continueOnError": true
      }
    ],
    "additionalMasterSecurityGroups": [
      "string"
    ],
    "additionalSlaveSecurityGroups": [
      "string"
    ]
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<emrCluster>
     <id>string</id>
     <status>string</status>
     <statusChangeReason>
          <code>string</code>
          <message>string</message>
     </statusChangeReason>
     <statusTimeline>
          <creationTime>2015-12-25T00:00:00.000-05:00</creationTime>
          <readyTime>2015-12-25T00:00:00.000-05:00</readyTime>
          <endTime>2015-12-25T00:00:00.000-05:00</endTime>
     </statusTimeline>
     <namespace>string</namespace>
     <emrClusterDefinitionName>string</emrClusterDefinitionName>
     <emrClusterName>string</emrClusterName>
     <activeStep>
          <id>string</id>
          <stepName>string</stepName>
          <jarLocation>string</jarLocation>
          <mainClass>string</mainClass>
          <scriptArguments>
               <argument>string</argument>
          </scriptArguments>
          <continueOnError>string</continueOnError>
          <status>string</status>
     </activeStep>
     <step>
          <id>string</id>
          <stepName>string</stepName>
          <jarLocation>string</jarLocation>
          <mainClass>string</mainClass>
          <scriptArguments>
               <argument>string</argument>
          </scriptArguments>
          <continueOnError>string</continueOnError>
          <status>string</status>
     </step>
     <oozieWorkflowJobs>
          <workflowJob>
               <id>string</id>
               <namespace>string</namespace>
               <emrClusterDefinitionName>string</emrClusterDefinitionName>
               <emrClusterName>string</emrClusterName>
               <status>string</status>
               <errorCode>string</errorCode>
               <errorMessage>string</errorMessage>
               <startTime>2015-12-25T00:00:00.000-05:00</startTime>
               <endTime>2015-12-25T00:00:00.000-05:00</endTime>
               <workflowActions>
                    <workflowAction>
                         <id>string</id>
                         <name>string</name>
                         <status>string</status>
                         <startTime>2015-12-25T00:00:00.000-05:00</startTime>
                         <endTime>2015-12-25T00:00:00.000-05:00</endTime>
                         <errorCode>string</errorCode>
                         <errorMessage>string</errorMessage>
                    </workflowAction>
               </workflowActions>
               <emrClusterId>string</emrClusterId>
          </workflowJob>
     </oozieWorkflowJobs>
     <dryRun>true</dryRun>
     <emrClusterCreated>true</emrClusterCreated>
     <emrClusterDefinition>
          <sshKeyPairName>string</sshKeyPairName>
          <subnetId>string</subnetId>
          <logBucket>string</logBucket>
          <keepAlive>true</keepAlive>
          <visibleToAll>true</visibleToAll>
          <terminationProtection>true</terminationProtection>
          <encryptionEnabled>true</encryptionEnabled>
          <serviceIamRole>string</serviceIamRole>
          <ec2NodeIamProfileName>string</ec2NodeIamProfileName>
          <amiVersion>string</amiVersion>
          <releaseLabel>string</releaseLabel>
          <hadoopVersion>string</hadoopVersion>
          <hiveVersion>string</hiveVersion>
          <pigVersion>string</pigVersion>
          <installOozie>true</installOozie>
          <customBootstrapActionMaster>
               <scriptDefinition>
                    <scriptName>string</scriptName>
                    <scriptLocation>string</scriptLocation>
                    <scriptArguments>
                         <argument>string</argument>
                    </scriptArguments>
               </scriptDefinition>
          </customBootstrapActionMaster>
          <customBootstrapActionAll>
               <scriptDefinition>
                    <scriptName>string</scriptName>
                    <scriptLocation>string</scriptLocation>
                    <scriptArguments>
                         <argument>string</argument>
                    </scriptArguments>
               </scriptDefinition>
          </customBootstrapActionAll>
          <additionalInfo>string</additionalInfo>
          <instanceDefinitions>
               <masterInstances>
                    <instanceCount>0</instanceCount>
                    <instanceType>string</instanceType>
                    <instanceSpotPrice>0</instanceSpotPrice>
                    <instanceMaxSearchPrice>0</instanceMaxSearchPrice>
                    <instanceOnDemandThreshold>0</instanceOnDemandThreshold>
               </masterInstances>
               <coreInstances>
                    <instanceCount>0</instanceCount>
                    <instanceType>string</instanceType>
                    <instanceSpotPrice>0</instanceSpotPrice>
                    <instanceMaxSearchPrice>0</instanceMaxSearchPrice>
                    <instanceOnDemandThreshold>0</instanceOnDemandThreshold>
               </coreInstances>
               <taskInstances>
                    <instanceCount>0</instanceCount>
                    <instanceType>string</instanceType>
                    <instanceSpotPrice>0</instanceSpotPrice>
                    <instanceMaxSearchPrice>0</instanceMaxSearchPrice>
                    <instanceOnDemandThreshold>0</instanceOnDemandThreshold>
               </taskInstances>
          </instanceDefinitions>
          <nodeTags>
               <nodeTag>
                    <tagName>string</tagName>
                    <tagValue>string</tagValue>
               </nodeTag>
          </nodeTags>
          <supportedProduct>string</supportedProduct>
          <applications>
               <application>
                    <name>string</name>
                    <version>string</version>
                    <args>
                         <arg>string</arg>
                    </args>
                    <additionalInfoList>
                         <additionalInfo>
                              <name>string</name>
                              <value>string</value>
                         </additionalInfo>
                    </additionalInfoList>
               </application>
          </applications>
          <configurations>
               <configuration>
                    <classification>string</classification>
                    <configurations>
                         <configuration/>
                    </configurations>
                    <properties>
                         <property>
                              <name>string</name>
                              <value>string</value>
                         </property>
                    </properties>
               </configuration>
          </configurations>
          <daemonConfigurations>
               <daemonParam>
                    <name>string</name>
                    <value>string</value>
               </daemonParam>
          </daemonConfigurations>
          <hadoopConfigurations/>
          <hadoopJarSteps>
               <hadoopJarStep>
                    <stepName>string</stepName>
                    <jarLocation>string</jarLocation>
                    <mainClass>string</mainClass>
                    <scriptArguments>
                         <argument>string</argument>
                    </scriptArguments>
                    <continueOnError>true</continueOnError>
               </hadoopJarStep>
          </hadoopJarSteps>
          <additionalMasterSecurityGroups>
               <additionalMasterSecurityGroup>string</additionalMasterSecurityGroup>
          </additionalMasterSecurityGroups>
          <additionalSlaveSecurityGroups>
               <additionalSlaveSecurityGroup>string</additionalSlaveSecurityGroup>
          </additionalSlaveSecurityGroups>
     </emrClusterDefinition>
</emrCluster>

Response Content Type

get /emrClusters/namespaces/{namespace}/emrClusterDefinitionNames/{emrClusterDefinitionName}/emrClusterNames/{emrClusterName}

getEmrCluster

Implementation Notes

Gets an existing EMR cluster details.

Requires READ permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
emrClusterDefinitionName	the EMR cluster definition name	path	string
emrClusterName	the EMR cluster name	path	string
emrClusterId	the cluster id of the cluster to get details	query	string
emrStepId	the step id of the step to get details	query	string
verbose	parameter for whether to return detailed information	query	boolean
retrieveOozieJobs	parameter for whether to retrieve oozie job information	query	boolean

Response (Status 200)

emrCluster {

id (string, optional),

status (string, optional),

statusChangeReason (statusChangeReason, optional):

              The reason for the cluster status change.

,

statusTimeline (statusTimeline, optional):

              A timeline that represents the status of a cluster over the lifetime of the cluster.

,

namespace (string),

emrClusterDefinitionName (string),

emrClusterName (string),

activeStep (emrStep, optional),

step (emrStep, optional),

oozieWorkflowJobs (Array[oozieWorkflowJob], optional),

dryRun (boolean, optional),

emrClusterCreated (boolean, optional),

emrClusterDefinition (emrClusterDefinition, optional)

}
statusChangeReason {

code (string, optional):

              The programmatic code for the state change reason.

,

message (string, optional):

              The descriptive message for the state change reason.

}
statusTimeline {

creationTime (string, optional):

              The creation date and time of the cluster.

,

readyTime (string, optional):

              The date and time when the cluster was ready to execute steps.

,

endTime (string, optional):

              The date and time when the cluster was terminated.

}
emrStep {

id (string),

stepName (string),

jarLocation (string, optional),

mainClass (string, optional),

scriptArguments (Array[string], optional),

continueOnError (string, optional),

status (string)

}
oozieWorkflowJob {

id (string, optional),

namespace (string, optional),

emrClusterDefinitionName (string, optional),

emrClusterName (string, optional),

status (string, optional),

errorCode (string, optional),

errorMessage (string, optional),

startTime (string, optional),

endTime (string, optional),

workflowActions (Array[oozieWorkflowAction], optional),

emrClusterId (string, optional)

}
emrClusterDefinition {

sshKeyPairName (string, optional):

The name of the Amazon EC2 key pair to set as the connection credential

,

subnetId (string, optional):

A comma separated list of Amazon VPC subnets.

When multiple subnets are specified, the subnet in the AZ with the best price will be used.
When multiple subnets belong to the same AZ, the subnet with the largest amount of available IP's will be used.

Cross-VPC access in PROD will only accept internal/emr subnets at this time.

,

logBucket (string, optional):

Amazon S3 bucket to receive log files

,

keepAlive (boolean, optional):

Launch a cluster that continues running even after completing all its steps

,

visibleToAll (boolean, optional):

Makes the instances in an existing cluster visible to all IAM users

,

terminationProtection (boolean, optional):

Launch the cluster with termination protection enabled

,

encryptionEnabled (boolean, optional):

Volume level encryption for the disks (using custom scripts). Encryption is not supported for AMI versions lower than 3.1.0

,

serviceIamRole (string, optional):

Launches the Amazon EMR service with the specified IAM role

,

ec2NodeIamProfileName (string, optional):

Launches the EC2 instances of a cluster with the specified IAM role

,

amiVersion (string, optional):

Specify the version of the AMI to use

,

releaseLabel (string, optional):

The release label. Available from 4.x

,

hadoopVersion (string, optional):

Specify the version of Hadoop to install

,

hiveVersion (string, optional):

The Hive version to load

,

pigVersion (string, optional):

The Pig version to load

,

installOozie (boolean, optional),

customBootstrapActionMaster (Array[scriptDefinition], optional):

Bootstrapping scripts that are executed only on the Master node

,

customBootstrapActionAll (Array[scriptDefinition], optional):

Bootstrapping scripts that are executed on all the nodes

,

additionalInfo (string, optional):

Specifies additional information during cluster creation

,

instanceDefinitions (instanceDefinitions, optional):

Instance Group Definitions

,

nodeTags (Array[nodeTag], optional):

Custom tags to be applied on the EC2 nodes

,

supportedProduct (string, optional):

Installs third-party software on an Amazon EMR cluster

,

applications (Array[emrClusterDefinitionApplication], optional):

List of applications

,

configurations (Array[emrClusterDefinitionConfiguration], optional):

List of configurations

,

daemonConfigurations (Array[parameter], optional):

Predefined bootstrap action to configure hadoop daemons

,

hadoopConfigurations (Array[string], optional):

Predefined bootstrap action to specify hadoop configurations

,

hadoopJarSteps (Array[hadoopJarStep], optional):

Hadoop jar steps that are added, to be executed once the cluster is started

,

additionalMasterSecurityGroups (Array[string], optional):

List of additional master node security groups. The security group defined by the configuration value emr.herd.support.security.group will automatically be added whether this list is specified or not

,

additionalSlaveSecurityGroups (Array[string], optional):

List of additional slave node security groups

}
oozieWorkflowAction {

id (string, optional),

name (string, optional),

status (string, optional),

startTime (string, optional),

endTime (string, optional),

errorCode (string, optional),

errorMessage (string, optional)

}
scriptDefinition {

scriptName (string),

scriptLocation (string),

scriptArguments (Array[string], optional)

}
instanceDefinitions {

masterInstances (masterInstanceDefinition, optional),

coreInstances (instanceDefinition, optional),

taskInstances (instanceDefinition, optional)

}
nodeTag {

tagName (string),

tagValue (string)

}
emrClusterDefinitionApplication {

name (string, optional):

Application name

,

version (string, optional):

Application version

,

args (Array[string], optional):

List of arguments

,

additionalInfoList (Array[parameter], optional):

List of additional info

}
emrClusterDefinitionConfiguration {

classification (string, optional):

The configuration classification

,

configurations (Array[emrClusterDefinitionConfiguration], optional):

List of configurations

,

properties (Array[parameter], optional):

List of properties

}
parameter {

name (string):

              Name of the parameter

,

value (string, optional):

              Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the
              application logs

}
hadoopJarStep {

stepName (string),

jarLocation (string),

mainClass (string, optional),

scriptArguments (Array[string], optional),

continueOnError (boolean, optional)

}
masterInstanceDefinition {

instanceCount (integer, optional),

instanceType (string),

instanceSpotPrice (number, optional):

The instance bid price, in USD. If not specified, uses on-demand

,

instanceMaxSearchPrice (number, optional):

The maximum amount, in USD, to search for the best price. The best price search will only search for prices lower than this value. If a spot instance is selected by the search, this value will be the bid price

,

instanceOnDemandThreshold (number, optional):

The amount, in USD, you are willing to pay over the lowest spot price for an on-demand instance. Use this to dynamically balance the cost vs. stability of your instances.

If not specified, the search will not attempt to find an on-demand instance when a spot is found. This is the same behavior as when this parameter is set to $0.

}
instanceDefinition {

instanceCount (integer, optional),

instanceType (string),

instanceSpotPrice (number, optional),

instanceMaxSearchPrice (number, optional):

The maximum amount, in USD, to search for the best price. The best price search will only search for prices lower than this value. If a spot instance is selected by the search, this value will be the bid price.

,

instanceOnDemandThreshold (number, optional):

The amount, in USD, you are willing to pay over the lowest spot price for an on-demand instance. Use this to dynamically balance the cost vs. stability of your instances.

If not specified, the search will not attempt to find an on-demand instance when a spot is found. This is the same behavior as when this parameter is set to $0.

}

{
  "id": "string",
  "status": "string",
  "statusChangeReason": {
    "code": "string",
    "message": "string"
  },
  "statusTimeline": {
    "creationTime": "2017-04-29T14:40:26.950Z",
    "readyTime": "2017-04-29T14:40:26.950Z",
    "endTime": "2017-04-29T14:40:26.950Z"
  },
  "namespace": "string",
  "emrClusterDefinitionName": "string",
  "emrClusterName": "string",
  "activeStep": {
    "id": "string",
    "stepName": "string",
    "jarLocation": "string",
    "mainClass": "string",
    "scriptArguments": [
      "string"
    ],
    "continueOnError": "string",
    "status": "string"
  },
  "step": {
    "id": "string",
    "stepName": "string",
    "jarLocation": "string",
    "mainClass": "string",
    "scriptArguments": [
      "string"
    ],
    "continueOnError": "string",
    "status": "string"
  },
  "oozieWorkflowJobs": [
    "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<oozieWorkflowJob>\n   <id>string</id>\n   <namespace>string</namespace>\n   <emrClusterDefinitionName>string</emrClusterDefinitionName>\n   <emrClusterName>string</emrClusterName>\n   <status>string</status>\n   <errorCode>string</errorCode>\n   <errorMessage>string</errorMessage>\n   <startTime>2015-12-25T00:00:00.000-05:00</startTime>\n   <endTime>2015-12-25T00:00:00.000-05:00</endTime>\n   <workflowActions>\n      <workflowAction>\n         <id>string</id>\n         <name>string</name>\n         <status>string</status>\n         <startTime>2015-12-25T00:00:00.000-05:00</startTime>\n         <endTime>2015-12-25T00:00:00.000-05:00</endTime>\n         <errorCode>string</errorCode>\n         <errorMessage>string</errorMessage>\n      </workflowAction>\n   </workflowActions>\n   <emrClusterId>string</emrClusterId>\n</oozieWorkflowJob>\n"
  ],
  "dryRun": true,
  "emrClusterCreated": true,
  "emrClusterDefinition": {
    "sshKeyPairName": "string",
    "subnetId": "string",
    "logBucket": "string",
    "keepAlive": true,
    "visibleToAll": true,
    "terminationProtection": true,
    "encryptionEnabled": true,
    "serviceIamRole": "string",
    "ec2NodeIamProfileName": "string",
    "amiVersion": "string",
    "releaseLabel": "string",
    "hadoopVersion": "string",
    "hiveVersion": "string",
    "pigVersion": "string",
    "installOozie": true,
    "customBootstrapActionMaster": [
      {
        "scriptName": "string",
        "scriptLocation": "string",
        "scriptArguments": [
          "string"
        ]
      }
    ],
    "customBootstrapActionAll": [
      {
        "scriptName": "string",
        "scriptLocation": "string",
        "scriptArguments": [
          "string"
        ]
      }
    ],
    "additionalInfo": "string",
    "instanceDefinitions": {
      "masterInstances": {
        "instanceCount": 0,
        "instanceType": "string",
        "instanceSpotPrice": 0,
        "instanceMaxSearchPrice": 0,
        "instanceOnDemandThreshold": 0
      },
      "coreInstances": {
        "instanceCount": 0,
        "instanceType": "string",
        "instanceSpotPrice": 0,
        "instanceMaxSearchPrice": 0,
        "instanceOnDemandThreshold": 0
      },
      "taskInstances": {
        "instanceCount": 0,
        "instanceType": "string",
        "instanceSpotPrice": 0,
        "instanceMaxSearchPrice": 0,
        "instanceOnDemandThreshold": 0
      }
    },
    "nodeTags": [
      {
        "tagName": "string",
        "tagValue": "string"
      }
    ],
    "supportedProduct": "string",
    "applications": [
      {
        "name": "string",
        "version": "string",
        "args": [
          "string"
        ],
        "additionalInfoList": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "configurations": [
      {
        "classification": "string",
        "configurations": [
          {}
        ],
        "properties": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "daemonConfigurations": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "hadoopConfigurations": [
      "string"
    ],
    "hadoopJarSteps": [
      {
        "stepName": "string",
        "jarLocation": "string",
        "mainClass": "string",
        "scriptArguments": [
          "string"
        ],
        "continueOnError": true
      }
    ],
    "additionalMasterSecurityGroups": [
      "string"
    ],
    "additionalSlaveSecurityGroups": [
      "string"
    ]
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<emrCluster>
     <id>string</id>
     <status>string</status>
     <statusChangeReason>
          <code>string</code>
          <message>string</message>
     </statusChangeReason>
     <statusTimeline>
          <creationTime>2015-12-25T00:00:00.000-05:00</creationTime>
          <readyTime>2015-12-25T00:00:00.000-05:00</readyTime>
          <endTime>2015-12-25T00:00:00.000-05:00</endTime>
     </statusTimeline>
     <namespace>string</namespace>
     <emrClusterDefinitionName>string</emrClusterDefinitionName>
     <emrClusterName>string</emrClusterName>
     <activeStep>
          <id>string</id>
          <stepName>string</stepName>
          <jarLocation>string</jarLocation>
          <mainClass>string</mainClass>
          <scriptArguments>
               <argument>string</argument>
          </scriptArguments>
          <continueOnError>string</continueOnError>
          <status>string</status>
     </activeStep>
     <step>
          <id>string</id>
          <stepName>string</stepName>
          <jarLocation>string</jarLocation>
          <mainClass>string</mainClass>
          <scriptArguments>
               <argument>string</argument>
          </scriptArguments>
          <continueOnError>string</continueOnError>
          <status>string</status>
     </step>
     <oozieWorkflowJobs>
          <workflowJob>
               <id>string</id>
               <namespace>string</namespace>
               <emrClusterDefinitionName>string</emrClusterDefinitionName>
               <emrClusterName>string</emrClusterName>
               <status>string</status>
               <errorCode>string</errorCode>
               <errorMessage>string</errorMessage>
               <startTime>2015-12-25T00:00:00.000-05:00</startTime>
               <endTime>2015-12-25T00:00:00.000-05:00</endTime>
               <workflowActions>
                    <workflowAction>
                         <id>string</id>
                         <name>string</name>
                         <status>string</status>
                         <startTime>2015-12-25T00:00:00.000-05:00</startTime>
                         <endTime>2015-12-25T00:00:00.000-05:00</endTime>
                         <errorCode>string</errorCode>
                         <errorMessage>string</errorMessage>
                    </workflowAction>
               </workflowActions>
               <emrClusterId>string</emrClusterId>
          </workflowJob>
     </oozieWorkflowJobs>
     <dryRun>true</dryRun>
     <emrClusterCreated>true</emrClusterCreated>
     <emrClusterDefinition>
          <sshKeyPairName>string</sshKeyPairName>
          <subnetId>string</subnetId>
          <logBucket>string</logBucket>
          <keepAlive>true</keepAlive>
          <visibleToAll>true</visibleToAll>
          <terminationProtection>true</terminationProtection>
          <encryptionEnabled>true</encryptionEnabled>
          <serviceIamRole>string</serviceIamRole>
          <ec2NodeIamProfileName>string</ec2NodeIamProfileName>
          <amiVersion>string</amiVersion>
          <releaseLabel>string</releaseLabel>
          <hadoopVersion>string</hadoopVersion>
          <hiveVersion>string</hiveVersion>
          <pigVersion>string</pigVersion>
          <installOozie>true</installOozie>
          <customBootstrapActionMaster>
               <scriptDefinition>
                    <scriptName>string</scriptName>
                    <scriptLocation>string</scriptLocation>
                    <scriptArguments>
                         <argument>string</argument>
                    </scriptArguments>
               </scriptDefinition>
          </customBootstrapActionMaster>
          <customBootstrapActionAll>
               <scriptDefinition>
                    <scriptName>string</scriptName>
                    <scriptLocation>string</scriptLocation>
                    <scriptArguments>
                         <argument>string</argument>
                    </scriptArguments>
               </scriptDefinition>
          </customBootstrapActionAll>
          <additionalInfo>string</additionalInfo>
          <instanceDefinitions>
               <masterInstances>
                    <instanceCount>0</instanceCount>
                    <instanceType>string</instanceType>
                    <instanceSpotPrice>0</instanceSpotPrice>
                    <instanceMaxSearchPrice>0</instanceMaxSearchPrice>
                    <instanceOnDemandThreshold>0</instanceOnDemandThreshold>
               </masterInstances>
               <coreInstances>
                    <instanceCount>0</instanceCount>
                    <instanceType>string</instanceType>
                    <instanceSpotPrice>0</instanceSpotPrice>
                    <instanceMaxSearchPrice>0</instanceMaxSearchPrice>
                    <instanceOnDemandThreshold>0</instanceOnDemandThreshold>
               </coreInstances>
               <taskInstances>
                    <instanceCount>0</instanceCount>
                    <instanceType>string</instanceType>
                    <instanceSpotPrice>0</instanceSpotPrice>
                    <instanceMaxSearchPrice>0</instanceMaxSearchPrice>
                    <instanceOnDemandThreshold>0</instanceOnDemandThreshold>
               </taskInstances>
          </instanceDefinitions>
          <nodeTags>
               <nodeTag>
                    <tagName>string</tagName>
                    <tagValue>string</tagValue>
               </nodeTag>
          </nodeTags>
          <supportedProduct>string</supportedProduct>
          <applications>
               <application>
                    <name>string</name>
                    <version>string</version>
                    <args>
                         <arg>string</arg>
                    </args>
                    <additionalInfoList>
                         <additionalInfo>
                              <name>string</name>
                              <value>string</value>
                         </additionalInfo>
                    </additionalInfoList>
               </application>
          </applications>
          <configurations>
               <configuration>
                    <classification>string</classification>
                    <configurations>
                         <configuration/>
                    </configurations>
                    <properties>
                         <property>
                              <name>string</name>
                              <value>string</value>
                         </property>
                    </properties>
               </configuration>
          </configurations>
          <daemonConfigurations>
               <daemonParam>
                    <name>string</name>
                    <value>string</value>
               </daemonParam>
          </daemonConfigurations>
          <hadoopConfigurations/>
          <hadoopJarSteps>
               <hadoopJarStep>
                    <stepName>string</stepName>
                    <jarLocation>string</jarLocation>
                    <mainClass>string</mainClass>
                    <scriptArguments>
                         <argument>string</argument>
                    </scriptArguments>
                    <continueOnError>true</continueOnError>
               </hadoopJarStep>
          </hadoopJarSteps>
          <additionalMasterSecurityGroups>
               <additionalMasterSecurityGroup>string</additionalMasterSecurityGroup>
          </additionalMasterSecurityGroups>
          <additionalSlaveSecurityGroups>
               <additionalSlaveSecurityGroup>string</additionalSlaveSecurityGroup>
          </additionalSlaveSecurityGroups>
     </emrClusterDefinition>
</emrCluster>

Response Content Type

delete /emrClusters/namespaces/{namespace}/emrClusterDefinitionNames/{emrClusterDefinitionName}/emrClusterNames/{emrClusterName}

terminateEmrCluster

Implementation Notes

Terminates an existing EMR cluster.

Requires EXECUTE permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
emrClusterDefinitionName	the EMR cluster definition name	path	string
emrClusterName	the EMR cluster name	path	string
overrideTerminationProtection	parameter for whether to override termination protection	query	boolean
emrClusterId	EMR cluster ID	query	string

Response (Status 200)

emrCluster {

id (string, optional),

status (string, optional),

statusChangeReason (statusChangeReason, optional):

              The reason for the cluster status change.

,

statusTimeline (statusTimeline, optional):

              A timeline that represents the status of a cluster over the lifetime of the cluster.

,

namespace (string),

emrClusterDefinitionName (string),

emrClusterName (string),

activeStep (emrStep, optional),

step (emrStep, optional),

oozieWorkflowJobs (Array[oozieWorkflowJob], optional),

dryRun (boolean, optional),

emrClusterCreated (boolean, optional),

emrClusterDefinition (emrClusterDefinition, optional)

}
statusChangeReason {

code (string, optional):

              The programmatic code for the state change reason.

,

message (string, optional):

              The descriptive message for the state change reason.

}
statusTimeline {

creationTime (string, optional):

              The creation date and time of the cluster.

,

readyTime (string, optional):

              The date and time when the cluster was ready to execute steps.

,

endTime (string, optional):

              The date and time when the cluster was terminated.

}
emrStep {

id (string),

stepName (string),

jarLocation (string, optional),

mainClass (string, optional),

scriptArguments (Array[string], optional),

continueOnError (string, optional),

status (string)

}
oozieWorkflowJob {

id (string, optional),

namespace (string, optional),

emrClusterDefinitionName (string, optional),

emrClusterName (string, optional),

status (string, optional),

errorCode (string, optional),

errorMessage (string, optional),

startTime (string, optional),

endTime (string, optional),

workflowActions (Array[oozieWorkflowAction], optional),

emrClusterId (string, optional)

}
emrClusterDefinition {

sshKeyPairName (string, optional):

The name of the Amazon EC2 key pair to set as the connection credential

,

subnetId (string, optional):

A comma separated list of Amazon VPC subnets.

When multiple subnets are specified, the subnet in the AZ with the best price will be used.
When multiple subnets belong to the same AZ, the subnet with the largest amount of available IP's will be used.

Cross-VPC access in PROD will only accept internal/emr subnets at this time.

,

logBucket (string, optional):

Amazon S3 bucket to receive log files

,

keepAlive (boolean, optional):

Launch a cluster that continues running even after completing all its steps

,

visibleToAll (boolean, optional):

Makes the instances in an existing cluster visible to all IAM users

,

terminationProtection (boolean, optional):

Launch the cluster with termination protection enabled

,

encryptionEnabled (boolean, optional):

Volume level encryption for the disks (using custom scripts). Encryption is not supported for AMI versions lower than 3.1.0

,

serviceIamRole (string, optional):

Launches the Amazon EMR service with the specified IAM role

,

ec2NodeIamProfileName (string, optional):

Launches the EC2 instances of a cluster with the specified IAM role

,

amiVersion (string, optional):

Specify the version of the AMI to use

,

releaseLabel (string, optional):

The release label. Available from 4.x

,

hadoopVersion (string, optional):

Specify the version of Hadoop to install

,

hiveVersion (string, optional):

The Hive version to load

,

pigVersion (string, optional):

The Pig version to load

,

installOozie (boolean, optional),

customBootstrapActionMaster (Array[scriptDefinition], optional):

Bootstrapping scripts that are executed only on the Master node

,

customBootstrapActionAll (Array[scriptDefinition], optional):

Bootstrapping scripts that are executed on all the nodes

,

additionalInfo (string, optional):

Specifies additional information during cluster creation

,

instanceDefinitions (instanceDefinitions, optional):

Instance Group Definitions

,

nodeTags (Array[nodeTag], optional):

Custom tags to be applied on the EC2 nodes

,

supportedProduct (string, optional):

Installs third-party software on an Amazon EMR cluster

,

applications (Array[emrClusterDefinitionApplication], optional):

List of applications

,

configurations (Array[emrClusterDefinitionConfiguration], optional):

List of configurations

,

daemonConfigurations (Array[parameter], optional):

Predefined bootstrap action to configure hadoop daemons

,

hadoopConfigurations (Array[string], optional):

Predefined bootstrap action to specify hadoop configurations

,

hadoopJarSteps (Array[hadoopJarStep], optional):

Hadoop jar steps that are added, to be executed once the cluster is started

,

additionalMasterSecurityGroups (Array[string], optional):

List of additional master node security groups. The security group defined by the configuration value emr.herd.support.security.group will automatically be added whether this list is specified or not

,

additionalSlaveSecurityGroups (Array[string], optional):

List of additional slave node security groups

}
oozieWorkflowAction {

id (string, optional),

name (string, optional),

status (string, optional),

startTime (string, optional),

endTime (string, optional),

errorCode (string, optional),

errorMessage (string, optional)

}
scriptDefinition {

scriptName (string),

scriptLocation (string),

scriptArguments (Array[string], optional)

}
instanceDefinitions {

masterInstances (masterInstanceDefinition, optional),

coreInstances (instanceDefinition, optional),

taskInstances (instanceDefinition, optional)

}
nodeTag {

tagName (string),

tagValue (string)

}
emrClusterDefinitionApplication {

name (string, optional):

Application name

,

version (string, optional):

Application version

,

args (Array[string], optional):

List of arguments

,

additionalInfoList (Array[parameter], optional):

List of additional info

}
emrClusterDefinitionConfiguration {

classification (string, optional):

The configuration classification

,

configurations (Array[emrClusterDefinitionConfiguration], optional):

List of configurations

,

properties (Array[parameter], optional):

List of properties

}
parameter {

name (string):

              Name of the parameter

,

value (string, optional):

              Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the
              application logs

}
hadoopJarStep {

stepName (string),

jarLocation (string),

mainClass (string, optional),

scriptArguments (Array[string], optional),

continueOnError (boolean, optional)

}
masterInstanceDefinition {

instanceCount (integer, optional),

instanceType (string),

instanceSpotPrice (number, optional):

The instance bid price, in USD. If not specified, uses on-demand

,

instanceMaxSearchPrice (number, optional):

The maximum amount, in USD, to search for the best price. The best price search will only search for prices lower than this value. If a spot instance is selected by the search, this value will be the bid price

,

instanceOnDemandThreshold (number, optional):

The amount, in USD, you are willing to pay over the lowest spot price for an on-demand instance. Use this to dynamically balance the cost vs. stability of your instances.

If not specified, the search will not attempt to find an on-demand instance when a spot is found. This is the same behavior as when this parameter is set to $0.

}
instanceDefinition {

instanceCount (integer, optional),

instanceType (string),

instanceSpotPrice (number, optional),

instanceMaxSearchPrice (number, optional):

The maximum amount, in USD, to search for the best price. The best price search will only search for prices lower than this value. If a spot instance is selected by the search, this value will be the bid price.

,

instanceOnDemandThreshold (number, optional):

The amount, in USD, you are willing to pay over the lowest spot price for an on-demand instance. Use this to dynamically balance the cost vs. stability of your instances.

If not specified, the search will not attempt to find an on-demand instance when a spot is found. This is the same behavior as when this parameter is set to $0.

}

{
  "id": "string",
  "status": "string",
  "statusChangeReason": {
    "code": "string",
    "message": "string"
  },
  "statusTimeline": {
    "creationTime": "2017-04-29T14:40:26.958Z",
    "readyTime": "2017-04-29T14:40:26.958Z",
    "endTime": "2017-04-29T14:40:26.958Z"
  },
  "namespace": "string",
  "emrClusterDefinitionName": "string",
  "emrClusterName": "string",
  "activeStep": {
    "id": "string",
    "stepName": "string",
    "jarLocation": "string",
    "mainClass": "string",
    "scriptArguments": [
      "string"
    ],
    "continueOnError": "string",
    "status": "string"
  },
  "step": {
    "id": "string",
    "stepName": "string",
    "jarLocation": "string",
    "mainClass": "string",
    "scriptArguments": [
      "string"
    ],
    "continueOnError": "string",
    "status": "string"
  },
  "oozieWorkflowJobs": [
    "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<oozieWorkflowJob>\n   <id>string</id>\n   <namespace>string</namespace>\n   <emrClusterDefinitionName>string</emrClusterDefinitionName>\n   <emrClusterName>string</emrClusterName>\n   <status>string</status>\n   <errorCode>string</errorCode>\n   <errorMessage>string</errorMessage>\n   <startTime>2015-12-25T00:00:00.000-05:00</startTime>\n   <endTime>2015-12-25T00:00:00.000-05:00</endTime>\n   <workflowActions>\n      <workflowAction>\n         <id>string</id>\n         <name>string</name>\n         <status>string</status>\n         <startTime>2015-12-25T00:00:00.000-05:00</startTime>\n         <endTime>2015-12-25T00:00:00.000-05:00</endTime>\n         <errorCode>string</errorCode>\n         <errorMessage>string</errorMessage>\n      </workflowAction>\n   </workflowActions>\n   <emrClusterId>string</emrClusterId>\n</oozieWorkflowJob>\n"
  ],
  "dryRun": true,
  "emrClusterCreated": true,
  "emrClusterDefinition": {
    "sshKeyPairName": "string",
    "subnetId": "string",
    "logBucket": "string",
    "keepAlive": true,
    "visibleToAll": true,
    "terminationProtection": true,
    "encryptionEnabled": true,
    "serviceIamRole": "string",
    "ec2NodeIamProfileName": "string",
    "amiVersion": "string",
    "releaseLabel": "string",
    "hadoopVersion": "string",
    "hiveVersion": "string",
    "pigVersion": "string",
    "installOozie": true,
    "customBootstrapActionMaster": [
      {
        "scriptName": "string",
        "scriptLocation": "string",
        "scriptArguments": [
          "string"
        ]
      }
    ],
    "customBootstrapActionAll": [
      {
        "scriptName": "string",
        "scriptLocation": "string",
        "scriptArguments": [
          "string"
        ]
      }
    ],
    "additionalInfo": "string",
    "instanceDefinitions": {
      "masterInstances": {
        "instanceCount": 0,
        "instanceType": "string",
        "instanceSpotPrice": 0,
        "instanceMaxSearchPrice": 0,
        "instanceOnDemandThreshold": 0
      },
      "coreInstances": {
        "instanceCount": 0,
        "instanceType": "string",
        "instanceSpotPrice": 0,
        "instanceMaxSearchPrice": 0,
        "instanceOnDemandThreshold": 0
      },
      "taskInstances": {
        "instanceCount": 0,
        "instanceType": "string",
        "instanceSpotPrice": 0,
        "instanceMaxSearchPrice": 0,
        "instanceOnDemandThreshold": 0
      }
    },
    "nodeTags": [
      {
        "tagName": "string",
        "tagValue": "string"
      }
    ],
    "supportedProduct": "string",
    "applications": [
      {
        "name": "string",
        "version": "string",
        "args": [
          "string"
        ],
        "additionalInfoList": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "configurations": [
      {
        "classification": "string",
        "configurations": [
          {}
        ],
        "properties": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "daemonConfigurations": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "hadoopConfigurations": [
      "string"
    ],
    "hadoopJarSteps": [
      {
        "stepName": "string",
        "jarLocation": "string",
        "mainClass": "string",
        "scriptArguments": [
          "string"
        ],
        "continueOnError": true
      }
    ],
    "additionalMasterSecurityGroups": [
      "string"
    ],
    "additionalSlaveSecurityGroups": [
      "string"
    ]
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<emrCluster>
     <id>string</id>
     <status>string</status>
     <statusChangeReason>
          <code>string</code>
          <message>string</message>
     </statusChangeReason>
     <statusTimeline>
          <creationTime>2015-12-25T00:00:00.000-05:00</creationTime>
          <readyTime>2015-12-25T00:00:00.000-05:00</readyTime>
          <endTime>2015-12-25T00:00:00.000-05:00</endTime>
     </statusTimeline>
     <namespace>string</namespace>
     <emrClusterDefinitionName>string</emrClusterDefinitionName>
     <emrClusterName>string</emrClusterName>
     <activeStep>
          <id>string</id>
          <stepName>string</stepName>
          <jarLocation>string</jarLocation>
          <mainClass>string</mainClass>
          <scriptArguments>
               <argument>string</argument>
          </scriptArguments>
          <continueOnError>string</continueOnError>
          <status>string</status>
     </activeStep>
     <step>
          <id>string</id>
          <stepName>string</stepName>
          <jarLocation>string</jarLocation>
          <mainClass>string</mainClass>
          <scriptArguments>
               <argument>string</argument>
          </scriptArguments>
          <continueOnError>string</continueOnError>
          <status>string</status>
     </step>
     <oozieWorkflowJobs>
          <workflowJob>
               <id>string</id>
               <namespace>string</namespace>
               <emrClusterDefinitionName>string</emrClusterDefinitionName>
               <emrClusterName>string</emrClusterName>
               <status>string</status>
               <errorCode>string</errorCode>
               <errorMessage>string</errorMessage>
               <startTime>2015-12-25T00:00:00.000-05:00</startTime>
               <endTime>2015-12-25T00:00:00.000-05:00</endTime>
               <workflowActions>
                    <workflowAction>
                         <id>string</id>
                         <name>string</name>
                         <status>string</status>
                         <startTime>2015-12-25T00:00:00.000-05:00</startTime>
                         <endTime>2015-12-25T00:00:00.000-05:00</endTime>
                         <errorCode>string</errorCode>
                         <errorMessage>string</errorMessage>
                    </workflowAction>
               </workflowActions>
               <emrClusterId>string</emrClusterId>
          </workflowJob>
     </oozieWorkflowJobs>
     <dryRun>true</dryRun>
     <emrClusterCreated>true</emrClusterCreated>
     <emrClusterDefinition>
          <sshKeyPairName>string</sshKeyPairName>
          <subnetId>string</subnetId>
          <logBucket>string</logBucket>
          <keepAlive>true</keepAlive>
          <visibleToAll>true</visibleToAll>
          <terminationProtection>true</terminationProtection>
          <encryptionEnabled>true</encryptionEnabled>
          <serviceIamRole>string</serviceIamRole>
          <ec2NodeIamProfileName>string</ec2NodeIamProfileName>
          <amiVersion>string</amiVersion>
          <releaseLabel>string</releaseLabel>
          <hadoopVersion>string</hadoopVersion>
          <hiveVersion>string</hiveVersion>
          <pigVersion>string</pigVersion>
          <installOozie>true</installOozie>
          <customBootstrapActionMaster>
               <scriptDefinition>
                    <scriptName>string</scriptName>
                    <scriptLocation>string</scriptLocation>
                    <scriptArguments>
                         <argument>string</argument>
                    </scriptArguments>
               </scriptDefinition>
          </customBootstrapActionMaster>
          <customBootstrapActionAll>
               <scriptDefinition>
                    <scriptName>string</scriptName>
                    <scriptLocation>string</scriptLocation>
                    <scriptArguments>
                         <argument>string</argument>
                    </scriptArguments>
               </scriptDefinition>
          </customBootstrapActionAll>
          <additionalInfo>string</additionalInfo>
          <instanceDefinitions>
               <masterInstances>
                    <instanceCount>0</instanceCount>
                    <instanceType>string</instanceType>
                    <instanceSpotPrice>0</instanceSpotPrice>
                    <instanceMaxSearchPrice>0</instanceMaxSearchPrice>
                    <instanceOnDemandThreshold>0</instanceOnDemandThreshold>
               </masterInstances>
               <coreInstances>
                    <instanceCount>0</instanceCount>
                    <instanceType>string</instanceType>
                    <instanceSpotPrice>0</instanceSpotPrice>
                    <instanceMaxSearchPrice>0</instanceMaxSearchPrice>
                    <instanceOnDemandThreshold>0</instanceOnDemandThreshold>
               </coreInstances>
               <taskInstances>
                    <instanceCount>0</instanceCount>
                    <instanceType>string</instanceType>
                    <instanceSpotPrice>0</instanceSpotPrice>
                    <instanceMaxSearchPrice>0</instanceMaxSearchPrice>
                    <instanceOnDemandThreshold>0</instanceOnDemandThreshold>
               </taskInstances>
          </instanceDefinitions>
          <nodeTags>
               <nodeTag>
                    <tagName>string</tagName>
                    <tagValue>string</tagValue>
               </nodeTag>
          </nodeTags>
          <supportedProduct>string</supportedProduct>
          <applications>
               <application>
                    <name>string</name>
                    <version>string</version>
                    <args>
                         <arg>string</arg>
                    </args>
                    <additionalInfoList>
                         <additionalInfo>
                              <name>string</name>
                              <value>string</value>
                         </additionalInfo>
                    </additionalInfoList>
               </application>
          </applications>
          <configurations>
               <configuration>
                    <classification>string</classification>
                    <configurations>
                         <configuration/>
                    </configurations>
                    <properties>
                         <property>
                              <name>string</name>
                              <value>string</value>
                         </property>
                    </properties>
               </configuration>
          </configurations>
          <daemonConfigurations>
               <daemonParam>
                    <name>string</name>
                    <value>string</value>
               </daemonParam>
          </daemonConfigurations>
          <hadoopConfigurations/>
          <hadoopJarSteps>
               <hadoopJarStep>
                    <stepName>string</stepName>
                    <jarLocation>string</jarLocation>
                    <mainClass>string</mainClass>
                    <scriptArguments>
                         <argument>string</argument>
                    </scriptArguments>
                    <continueOnError>true</continueOnError>
               </hadoopJarStep>
          </hadoopJarSteps>
          <additionalMasterSecurityGroups>
               <additionalMasterSecurityGroup>string</additionalMasterSecurityGroup>
          </additionalMasterSecurityGroups>
          <additionalSlaveSecurityGroups>
               <additionalSlaveSecurityGroup>string</additionalSlaveSecurityGroup>
          </additionalSlaveSecurityGroups>
     </emrClusterDefinition>
</emrCluster>

Response Content Type

post /emrHadoopJarSteps

addHadoopJarStepToEmrCluster

Implementation Notes

Adds a Hadoop Jar step to the existing cluster

Requires EXECUTE permission on namespace

Parameter (body): the information needed to add Hadoop Jar step to the EMR cluster.

Parameter content type:

emrHadoopJarStepAddRequest {

namespace (string),

emrClusterDefinitionName (string),

emrClusterName (string),

stepName (string),

jarLocation (string),

mainClass (string, optional),

scriptArguments (Array[string], optional),

continueOnError (boolean, optional),

emrClusterId (string, optional)

}

{
  "namespace": "string",
  "emrClusterDefinitionName": "string",
  "emrClusterName": "string",
  "stepName": "string",
  "jarLocation": "string",
  "mainClass": "string",
  "scriptArguments": [
    "string"
  ],
  "continueOnError": true,
  "emrClusterId": "string"
}

Click to set as parameter value

<?xml version="1.0" encoding="UTF-8"?>
<emrHadoopJarStepAddRequest>
     <namespace>string</namespace>
     <emrClusterDefinitionName>string</emrClusterDefinitionName>
     <emrClusterName>string</emrClusterName>
     <stepName>string</stepName>
     <jarLocation>string</jarLocation>
     <mainClass>string</mainClass>
     <scriptArguments>
          <argument>string</argument>
     </scriptArguments>
     <continueOnError>true</continueOnError>
     <emrClusterId>string</emrClusterId>
</emrHadoopJarStepAddRequest>

Click to set as parameter value

Response (Status 200)

emrHadoopJarStep {

id (string),

namespace (string),

emrClusterDefinitionName (string),

emrClusterName (string),

stepName (string),

jarLocation (string),

mainClass (string, optional),

scriptArguments (Array[string], optional),

continueOnError (boolean, optional),

emrClusterId (string, optional)

}

{
  "id": "string",
  "namespace": "string",
  "emrClusterDefinitionName": "string",
  "emrClusterName": "string",
  "stepName": "string",
  "jarLocation": "string",
  "mainClass": "string",
  "scriptArguments": [
    "string"
  ],
  "continueOnError": true,
  "emrClusterId": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<emrHadoopJarStep>
     <id>string</id>
     <namespace>string</namespace>
     <emrClusterDefinitionName>string</emrClusterDefinitionName>
     <emrClusterName>string</emrClusterName>
     <stepName>string</stepName>
     <jarLocation>string</jarLocation>
     <mainClass>string</mainClass>
     <scriptArguments>
          <argument>string</argument>
     </scriptArguments>
     <continueOnError>true</continueOnError>
     <emrClusterId>string</emrClusterId>
</emrHadoopJarStep>

Response Content Type

post /emrHiveSteps

addHiveStepToEmrCluster

Implementation Notes

Adds a hive step to the existing cluster

Requires EXECUTE permission on namespace

Parameter (body): the information needed to add hive step to the EMR cluster.

Parameter content type:

emrHiveStepAddRequest {

namespace (string),

emrClusterDefinitionName (string),

emrClusterName (string),

stepName (string),

scriptLocation (string),

scriptArguments (Array[string], optional),

continueOnError (boolean, optional),

emrClusterId (string, optional)

}

{
  "namespace": "string",
  "emrClusterDefinitionName": "string",
  "emrClusterName": "string",
  "stepName": "string",
  "scriptLocation": "string",
  "scriptArguments": [
    "string"
  ],
  "continueOnError": true,
  "emrClusterId": "string"
}

Click to set as parameter value

<?xml version="1.0" encoding="UTF-8"?>
<emrHiveStepAddRequest>
     <namespace>string</namespace>
     <emrClusterDefinitionName>string</emrClusterDefinitionName>
     <emrClusterName>string</emrClusterName>
     <stepName>string</stepName>
     <scriptLocation>string</scriptLocation>
     <scriptArguments>
          <argument>string</argument>
     </scriptArguments>
     <continueOnError>true</continueOnError>
     <emrClusterId>string</emrClusterId>
</emrHiveStepAddRequest>

Click to set as parameter value

Response (Status 200)

emrHiveStep {

id (string),

namespace (string),

emrClusterDefinitionName (string),

emrClusterName (string),

stepName (string),

scriptLocation (string),

scriptArguments (Array[string], optional),

continueOnError (boolean, optional),

emrClusterId (string, optional)

}

{
  "id": "string",
  "namespace": "string",
  "emrClusterDefinitionName": "string",
  "emrClusterName": "string",
  "stepName": "string",
  "scriptLocation": "string",
  "scriptArguments": [
    "string"
  ],
  "continueOnError": true,
  "emrClusterId": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<emrHiveStep>
     <id>string</id>
     <namespace>string</namespace>
     <emrClusterDefinitionName>string</emrClusterDefinitionName>
     <emrClusterName>string</emrClusterName>
     <stepName>string</stepName>
     <scriptLocation>string</scriptLocation>
     <scriptArguments>
          <argument>string</argument>
     </scriptArguments>
     <continueOnError>true</continueOnError>
     <emrClusterId>string</emrClusterId>
</emrHiveStep>

Response Content Type

post /emrMasterSecurityGroups

addGroupsToEmrClusterMaster

Implementation Notes

Adds security groups to the master node of an existing cluster

Requires WRITE permission on namespace

Parameter (body): the information needed to add security groups to master node of the EMR cluster.

Parameter content type:

emrMasterSecurityGroupAddRequest {

namespace (string),

emrClusterDefinitionName (string),

emrClusterName (string),

securityGroupIds (Array[string], optional),

emrClusterId (string, optional)

}

{
  "namespace": "string",
  "emrClusterDefinitionName": "string",
  "emrClusterName": "string",
  "securityGroupIds": [
    "string"
  ],
  "emrClusterId": "string"
}

Click to set as parameter value

<?xml version="1.0" encoding="UTF-8"?>
<emrMasterSecurityGroupAddRequest>
     <namespace>string</namespace>
     <emrClusterDefinitionName>string</emrClusterDefinitionName>
     <emrClusterName>string</emrClusterName>
     <securityGroupIds>
          <securityGroupId>string</securityGroupId>
     </securityGroupIds>
     <emrClusterId>string</emrClusterId>
</emrMasterSecurityGroupAddRequest>

Click to set as parameter value

Response (Status 200)

emrMasterSecurityGroup {

namespace (string),

emrClusterDefinitionName (string),

emrClusterName (string),

securityGroupIds (Array[string], optional),

emrClusterId (string, optional)

}

{
  "namespace": "string",
  "emrClusterDefinitionName": "string",
  "emrClusterName": "string",
  "securityGroupIds": [
    "string"
  ],
  "emrClusterId": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<emrMasterSecurityGroup>
     <namespace>string</namespace>
     <emrClusterDefinitionName>string</emrClusterDefinitionName>
     <emrClusterName>string</emrClusterName>
     <securityGroupIds>
          <securityGroupId>string</securityGroupId>
     </securityGroupIds>
     <emrClusterId>string</emrClusterId>
</emrMasterSecurityGroup>

Response Content Type

post /emrOozieSteps

addOozieStepToEmrCluster

Implementation Notes

Adds a oozie step to the existing cluster

Requires EXECUTE permission on namespace

Parameter (body): the information needed to add oozie step to the EMR cluster.

Parameter content type:

emrOozieStepAddRequest {

namespace (string),

emrClusterDefinitionName (string),

emrClusterName (string),

stepName (string),

workflowXmlLocation (string),

ooziePropertiesFileLocation (string),

continueOnError (boolean, optional),

emrClusterId (string, optional)

}

{
  "namespace": "string",
  "emrClusterDefinitionName": "string",
  "emrClusterName": "string",
  "stepName": "string",
  "workflowXmlLocation": "string",
  "ooziePropertiesFileLocation": "string",
  "continueOnError": true,
  "emrClusterId": "string"
}

Click to set as parameter value

<?xml version="1.0" encoding="UTF-8"?>
<emrOozieStepAddRequest>
     <namespace>string</namespace>
     <emrClusterDefinitionName>string</emrClusterDefinitionName>
     <emrClusterName>string</emrClusterName>
     <stepName>string</stepName>
     <workflowXmlLocation>string</workflowXmlLocation>
     <ooziePropertiesFileLocation>string</ooziePropertiesFileLocation>
     <continueOnError>true</continueOnError>
     <emrClusterId>string</emrClusterId>
</emrOozieStepAddRequest>

Click to set as parameter value

Response (Status 200)

emrOozieStep {

id (string),

namespace (string),

emrClusterDefinitionName (string),

emrClusterName (string),

stepName (string),

workflowXmlLocation (string),

ooziePropertiesFileLocation (string),

continueOnError (boolean, optional),

emrClusterId (string, optional)

}

{
  "id": "string",
  "namespace": "string",
  "emrClusterDefinitionName": "string",
  "emrClusterName": "string",
  "stepName": "string",
  "workflowXmlLocation": "string",
  "ooziePropertiesFileLocation": "string",
  "continueOnError": true,
  "emrClusterId": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<emrOozieStep>
     <id>string</id>
     <namespace>string</namespace>
     <emrClusterDefinitionName>string</emrClusterDefinitionName>
     <emrClusterName>string</emrClusterName>
     <stepName>string</stepName>
     <workflowXmlLocation>string</workflowXmlLocation>
     <ooziePropertiesFileLocation>string</ooziePropertiesFileLocation>
     <continueOnError>true</continueOnError>
     <emrClusterId>string</emrClusterId>
</emrOozieStep>

Response Content Type

post /emrOozieWorkflows

runOozieJobToEmrCluster

Implementation Notes

Submits an oozie workflow to the existing cluster.

Requires EXECUTE permission on namespace

Parameter (body): the information needed to run oozie workflow to the EMR cluster.

Parameter content type:

runOozieWorkflowRequest {

namespace (string),

emrClusterDefinitionName (string),

emrClusterName (string),

workflowLocation (string),

parameters (Array[parameter], optional),

emrClusterId (string, optional)

}
parameter {

name (string):

              Name of the parameter

,

value (string, optional):

              Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the
              application logs

}

{
  "namespace": "string",
  "emrClusterDefinitionName": "string",
  "emrClusterName": "string",
  "workflowLocation": "string",
  "parameters": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "emrClusterId": "string"
}

Click to set as parameter value

<?xml version="1.0" encoding="UTF-8"?>
<runOozieWorkflowRequest>
     <namespace>string</namespace>
     <emrClusterDefinitionName>string</emrClusterDefinitionName>
     <emrClusterName>string</emrClusterName>
     <workflowLocation>string</workflowLocation>
     <parameters>
          <parameter>
               <name>string</name>
               <value>string</value>
          </parameter>
     </parameters>
     <emrClusterId>string</emrClusterId>
</runOozieWorkflowRequest>

Click to set as parameter value

Response (Status 200)

oozieWorkflowJob {

id (string, optional),

namespace (string, optional),

emrClusterDefinitionName (string, optional),

emrClusterName (string, optional),

status (string, optional),

errorCode (string, optional),

errorMessage (string, optional),

startTime (string, optional),

endTime (string, optional),

workflowActions (Array[oozieWorkflowAction], optional),

emrClusterId (string, optional)

}
oozieWorkflowAction {

id (string, optional),

name (string, optional),

status (string, optional),

startTime (string, optional),

endTime (string, optional),

errorCode (string, optional),

errorMessage (string, optional)

}

{
  "id": "string",
  "namespace": "string",
  "emrClusterDefinitionName": "string",
  "emrClusterName": "string",
  "status": "string",
  "errorCode": "string",
  "errorMessage": "string",
  "startTime": "2017-04-29T14:40:26.977Z",
  "endTime": "2017-04-29T14:40:26.977Z",
  "workflowActions": [
    {
      "id": "string",
      "name": "string",
      "status": "string",
      "startTime": "2017-04-29T14:40:26.977Z",
      "endTime": "2017-04-29T14:40:26.977Z",
      "errorCode": "string",
      "errorMessage": "string"
    }
  ],
  "emrClusterId": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<oozieWorkflowJob>
     <id>string</id>
     <namespace>string</namespace>
     <emrClusterDefinitionName>string</emrClusterDefinitionName>
     <emrClusterName>string</emrClusterName>
     <status>string</status>
     <errorCode>string</errorCode>
     <errorMessage>string</errorMessage>
     <startTime>2015-12-25T00:00:00.000-05:00</startTime>
     <endTime>2015-12-25T00:00:00.000-05:00</endTime>
     <workflowActions>
          <workflowAction>
               <id>string</id>
               <name>string</name>
               <status>string</status>
               <startTime>2015-12-25T00:00:00.000-05:00</startTime>
               <endTime>2015-12-25T00:00:00.000-05:00</endTime>
               <errorCode>string</errorCode>
               <errorMessage>string</errorMessage>
          </workflowAction>
     </workflowActions>
     <emrClusterId>string</emrClusterId>
</oozieWorkflowJob>

Response Content Type

get /emrOozieWorkflows/namespaces/{namespace}/emrClusterDefinitionNames/{emrClusterDefinitionName}/emrClusterNames/{emrClusterName}/oozieWorkflowJobIds/{oozieWorkflowJobId}

getEmrOozieWorkflow

Implementation Notes

Retrieves an existing Oozie workflow job for the specified EMR cluster and workflow job ID.

Requires READ permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	Namespace of the EMR cluster	path	string
emrClusterDefinitionName	EMR cluster definition name	path	string
emrClusterName	EMR cluster name	path	string
oozieWorkflowJobId	Oozie workflow job ID	path	string
verbose	true to return more detailed information, false or null otherwise	query	boolean
emrClusterId	The EMR cluster ID	query	string

Response (Status 200)

oozieWorkflowJob {

id (string, optional),

namespace (string, optional),

emrClusterDefinitionName (string, optional),

emrClusterName (string, optional),

status (string, optional),

errorCode (string, optional),

errorMessage (string, optional),

startTime (string, optional),

endTime (string, optional),

workflowActions (Array[oozieWorkflowAction], optional),

emrClusterId (string, optional)

}
oozieWorkflowAction {

id (string, optional),

name (string, optional),

status (string, optional),

startTime (string, optional),

endTime (string, optional),

errorCode (string, optional),

errorMessage (string, optional)

}

{
  "id": "string",
  "namespace": "string",
  "emrClusterDefinitionName": "string",
  "emrClusterName": "string",
  "status": "string",
  "errorCode": "string",
  "errorMessage": "string",
  "startTime": "2017-04-29T14:40:26.979Z",
  "endTime": "2017-04-29T14:40:26.979Z",
  "workflowActions": [
    {
      "id": "string",
      "name": "string",
      "status": "string",
      "startTime": "2017-04-29T14:40:26.979Z",
      "endTime": "2017-04-29T14:40:26.979Z",
      "errorCode": "string",
      "errorMessage": "string"
    }
  ],
  "emrClusterId": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<oozieWorkflowJob>
     <id>string</id>
     <namespace>string</namespace>
     <emrClusterDefinitionName>string</emrClusterDefinitionName>
     <emrClusterName>string</emrClusterName>
     <status>string</status>
     <errorCode>string</errorCode>
     <errorMessage>string</errorMessage>
     <startTime>2015-12-25T00:00:00.000-05:00</startTime>
     <endTime>2015-12-25T00:00:00.000-05:00</endTime>
     <workflowActions>
          <workflowAction>
               <id>string</id>
               <name>string</name>
               <status>string</status>
               <startTime>2015-12-25T00:00:00.000-05:00</startTime>
               <endTime>2015-12-25T00:00:00.000-05:00</endTime>
               <errorCode>string</errorCode>
               <errorMessage>string</errorMessage>
          </workflowAction>
     </workflowActions>
     <emrClusterId>string</emrClusterId>
</oozieWorkflowJob>

Response Content Type

post /emrPigSteps

addPigStepToEmrCluster

Implementation Notes

Adds a Pig step to the existing cluster

Requires EXECUTE permission on namespace

Parameter (body): the information needed to add Pig step to the EMR cluster.

Parameter content type:

emrPigStepAddRequest {

namespace (string),

emrClusterDefinitionName (string),

emrClusterName (string),

stepName (string),

scriptLocation (string),

scriptArguments (Array[string], optional),

continueOnError (boolean, optional),

emrClusterId (string, optional)

}

{
  "namespace": "string",
  "emrClusterDefinitionName": "string",
  "emrClusterName": "string",
  "stepName": "string",
  "scriptLocation": "string",
  "scriptArguments": [
    "string"
  ],
  "continueOnError": true,
  "emrClusterId": "string"
}

Click to set as parameter value

<?xml version="1.0" encoding="UTF-8"?>
<emrPigStepAddRequest>
     <namespace>string</namespace>
     <emrClusterDefinitionName>string</emrClusterDefinitionName>
     <emrClusterName>string</emrClusterName>
     <stepName>string</stepName>
     <scriptLocation>string</scriptLocation>
     <scriptArguments>
          <argument>string</argument>
     </scriptArguments>
     <continueOnError>true</continueOnError>
     <emrClusterId>string</emrClusterId>
</emrPigStepAddRequest>

Click to set as parameter value

Response (Status 200)

emrPigStep {

id (string),

namespace (string),

emrClusterDefinitionName (string),

emrClusterName (string),

stepName (string),

scriptLocation (string),

scriptArguments (Array[string], optional),

continueOnError (boolean, optional),

emrClusterId (string, optional)

}

{
  "id": "string",
  "namespace": "string",
  "emrClusterDefinitionName": "string",
  "emrClusterName": "string",
  "stepName": "string",
  "scriptLocation": "string",
  "scriptArguments": [
    "string"
  ],
  "continueOnError": true,
  "emrClusterId": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<emrPigStep>
     <id>string</id>
     <namespace>string</namespace>
     <emrClusterDefinitionName>string</emrClusterDefinitionName>
     <emrClusterName>string</emrClusterName>
     <stepName>string</stepName>
     <scriptLocation>string</scriptLocation>
     <scriptArguments>
          <argument>string</argument>
     </scriptArguments>
     <continueOnError>true</continueOnError>
     <emrClusterId>string</emrClusterId>
</emrPigStep>

Response Content Type

post /emrShellSteps

addShellStepToEmrCluster

Implementation Notes

Adds a shell step to the existing cluster

Requires EXECUTE permission on namespace

Parameter (body): the information needed to add shell step to the EMR cluster.

Parameter content type:

emrShellStepAddRequest {

namespace (string),

emrClusterDefinitionName (string),

emrClusterName (string),

stepName (string),

scriptLocation (string),

scriptArguments (Array[string], optional),

continueOnError (boolean, optional),

emrClusterId (string, optional)

}

{
  "namespace": "string",
  "emrClusterDefinitionName": "string",
  "emrClusterName": "string",
  "stepName": "string",
  "scriptLocation": "string",
  "scriptArguments": [
    "string"
  ],
  "continueOnError": true,
  "emrClusterId": "string"
}

Click to set as parameter value

<?xml version="1.0" encoding="UTF-8"?>
<emrShellStepAddRequest>
     <namespace>string</namespace>
     <emrClusterDefinitionName>string</emrClusterDefinitionName>
     <emrClusterName>string</emrClusterName>
     <stepName>string</stepName>
     <scriptLocation>string</scriptLocation>
     <scriptArguments>
          <argument>string</argument>
     </scriptArguments>
     <continueOnError>true</continueOnError>
     <emrClusterId>string</emrClusterId>
</emrShellStepAddRequest>

Click to set as parameter value

Response (Status 200)

emrShellStep {

id (string),

namespace (string),

emrClusterDefinitionName (string),

emrClusterName (string),

stepName (string),

scriptLocation (string),

scriptArguments (Array[string], optional),

continueOnError (boolean, optional),

emrClusterId (string, optional)

}

{
  "id": "string",
  "namespace": "string",
  "emrClusterDefinitionName": "string",
  "emrClusterName": "string",
  "stepName": "string",
  "scriptLocation": "string",
  "scriptArguments": [
    "string"
  ],
  "continueOnError": true,
  "emrClusterId": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<emrShellStep>
     <id>string</id>
     <namespace>string</namespace>
     <emrClusterDefinitionName>string</emrClusterDefinitionName>
     <emrClusterName>string</emrClusterName>
     <stepName>string</stepName>
     <scriptLocation>string</scriptLocation>
     <scriptArguments>
          <argument>string</argument>
     </scriptArguments>
     <continueOnError>true</continueOnError>
     <emrClusterId>string</emrClusterId>
</emrShellStep>

Response Content Type

EMR Cluster Definition

post /emrClusterDefinitions

createEmrClusterDefinition

Implementation Notes

Creates a new EMR cluster definition.

Requires WRITE permission on namespace

Parameter (body): the information needed to create an EMR cluster definition
Parameter content type: Model JSON Schema XML Example emrClusterDefinitionCreateRequest { emrClusterDefinitionKey (emrClusterDefinitionKey), emrClusterDefinition (emrClusterDefinition) } emrClusterDefinitionKey { namespace (string): The namespace of the EMR cluster definition , emrClusterDefinitionName (string): The name of the EMR cluster definition } emrClusterDefinition { sshKeyPairName (string, optional): The name of the Amazon EC2 key pair to set as the connection credential , subnetId (string, optional): A comma separated list of Amazon VPC subnets. When multiple subnets are specified, the subnet in the AZ with the best price will be used. When multiple subnets belong to the same AZ, the subnet with the largest amount of available IP's will be used. Cross-VPC access in PROD will only accept internal/emr subnets at this time. , logBucket (string, optional): Amazon S3 bucket to receive log files , keepAlive (boolean, optional): Launch a cluster that continues running even after completing all its steps , visibleToAll (boolean, optional): Makes the instances in an existing cluster visible to all IAM users , terminationProtection (boolean, optional): Launch the cluster with termination protection enabled , encryptionEnabled (boolean, optional): Volume level encryption for the disks (using custom scripts). Encryption is not supported for AMI versions lower than 3.1.0 , serviceIamRole (string, optional): Launches the Amazon EMR service with the specified IAM role , ec2NodeIamProfileName (string, optional): Launches the EC2 instances of a cluster with the specified IAM role , amiVersion (string, optional): Specify the version of the AMI to use , releaseLabel (string, optional): The release label. Available from 4.x , hadoopVersion (string, optional): Specify the version of Hadoop to install , hiveVersion (string, optional): The Hive version to load , pigVersion (string, optional): The Pig version to load , installOozie (boolean, optional), customBootstrapActionMaster (Array[scriptDefinition], optional): Bootstrapping scripts that are executed only on the Master node , customBootstrapActionAll (Array[scriptDefinition], optional): Bootstrapping scripts that are executed on all the nodes , additionalInfo (string, optional): Specifies additional information during cluster creation , instanceDefinitions (instanceDefinitions, optional): Instance Group Definitions , nodeTags (Array[nodeTag], optional): Custom tags to be applied on the EC2 nodes , supportedProduct (string, optional): Installs third-party software on an Amazon EMR cluster , applications (Array[emrClusterDefinitionApplication], optional): List of applications , configurations (Array[emrClusterDefinitionConfiguration], optional): List of configurations , daemonConfigurations (Array[parameter], optional): Predefined bootstrap action to configure hadoop daemons , hadoopConfigurations (Array[string], optional): Predefined bootstrap action to specify hadoop configurations , hadoopJarSteps (Array[hadoopJarStep], optional): Hadoop jar steps that are added, to be executed once the cluster is started , additionalMasterSecurityGroups (Array[string], optional): List of additional master node security groups. The security group defined by the configuration value emr.herd.support.security.group will automatically be added whether this list is specified or not , additionalSlaveSecurityGroups (Array[string], optional): List of additional slave node security groups } scriptDefinition { scriptName (string), scriptLocation (string), scriptArguments (Array[string], optional) } instanceDefinitions { masterInstances (masterInstanceDefinition, optional), coreInstances (instanceDefinition, optional), taskInstances (instanceDefinition, optional) } nodeTag { tagName (string), tagValue (string) } emrClusterDefinitionApplication { name (string, optional): Application name , version (string, optional): Application version , args (Array[string], optional): List of arguments , additionalInfoList (Array[parameter], optional): List of additional info } emrClusterDefinitionConfiguration { classification (string, optional): The configuration classification , configurations (Array[emrClusterDefinitionConfiguration], optional): List of configurations , properties (Array[parameter], optional): List of properties } parameter { name (string): `Name of the parameter` , value (string, optional): `Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the application logs` } hadoopJarStep { stepName (string), jarLocation (string), mainClass (string, optional), scriptArguments (Array[string], optional), continueOnError (boolean, optional) } masterInstanceDefinition { instanceCount (integer, optional), instanceType (string), instanceSpotPrice (number, optional): The instance bid price, in USD. If not specified, uses on-demand , instanceMaxSearchPrice (number, optional): The maximum amount, in USD, to search for the best price. The best price search will only search for prices lower than this value. If a spot instance is selected by the search, this value will be the bid price , instanceOnDemandThreshold (number, optional): The amount, in USD, you are willing to pay over the lowest spot price for an on-demand instance. Use this to dynamically balance the cost vs. stability of your instances. If not specified, the search will not attempt to find an on-demand instance when a spot is found. This is the same behavior as when this parameter is set to $0. } instanceDefinition { instanceCount (integer, optional), instanceType (string), instanceSpotPrice (number, optional), instanceMaxSearchPrice (number, optional): The maximum amount, in USD, to search for the best price. The best price search will only search for prices lower than this value. If a spot instance is selected by the search, this value will be the bid price. , instanceOnDemandThreshold (number, optional): The amount, in USD, you are willing to pay over the lowest spot price for an on-demand instance. Use this to dynamically balance the cost vs. stability of your instances. If not specified, the search will not attempt to find an on-demand instance when a spot is found. This is the same behavior as when this parameter is set to $0. } { "emrClusterDefinitionKey": { "namespace": "string", "emrClusterDefinitionName": "string" }, "emrClusterDefinition": { "sshKeyPairName": "string", "subnetId": "string", "logBucket": "string", "keepAlive": true, "visibleToAll": true, "terminationProtection": true, "encryptionEnabled": true, "serviceIamRole": "string", "ec2NodeIamProfileName": "string", "amiVersion": "string", "releaseLabel": "string", "hadoopVersion": "string", "hiveVersion": "string", "pigVersion": "string", "installOozie": true, "customBootstrapActionMaster": [ { "scriptName": "string", "scriptLocation": "string", "scriptArguments": [ "string" ] } ], "customBootstrapActionAll": [ { "scriptName": "string", "scriptLocation": "string", "scriptArguments": [ "string" ] } ], "additionalInfo": "string", "instanceDefinitions": { "masterInstances": { "instanceCount": 0, "instanceType": "string", "instanceSpotPrice": 0, "instanceMaxSearchPrice": 0, "instanceOnDemandThreshold": 0 }, "coreInstances": { "instanceCount": 0, "instanceType": "string", "instanceSpotPrice": 0, "instanceMaxSearchPrice": 0, "instanceOnDemandThreshold": 0 }, "taskInstances": { "instanceCount": 0, "instanceType": "string", "instanceSpotPrice": 0, "instanceMaxSearchPrice": 0, "instanceOnDemandThreshold": 0 } }, "nodeTags": [ { "tagName": "string", "tagValue": "string" } ], "supportedProduct": "string", "applications": [ { "name": "string", "version": "string", "args": [ "string" ], "additionalInfoList": [ { "name": "string", "value": "string" } ] } ], "configurations": [ { "classification": "string", "configurations": [ {} ], "properties": [ { "name": "string", "value": "string" } ] } ], "daemonConfigurations": [ { "name": "string", "value": "string" } ], "hadoopConfigurations": [ "string" ], "hadoopJarSteps": [ { "stepName": "string", "jarLocation": "string", "mainClass": "string", "scriptArguments": [ "string" ], "continueOnError": true } ], "additionalMasterSecurityGroups": [ "string" ], "additionalSlaveSecurityGroups": [ "string" ] } } Click to set as parameter value <?xml version="1.0" encoding="UTF-8"?> <emrClusterDefinitionCreateRequest> <emrClusterDefinitionKey> <namespace>string</namespace> <emrClusterDefinitionName>string</emrClusterDefinitionName> </emrClusterDefinitionKey> <emrClusterDefinition> <sshKeyPairName>string</sshKeyPairName> <subnetId>string</subnetId> <logBucket>string</logBucket> <keepAlive>true</keepAlive> <visibleToAll>true</visibleToAll> <terminationProtection>true</terminationProtection> <encryptionEnabled>true</encryptionEnabled> <serviceIamRole>string</serviceIamRole> <ec2NodeIamProfileName>string</ec2NodeIamProfileName> <amiVersion>string</amiVersion> <releaseLabel>string</releaseLabel> <hadoopVersion>string</hadoopVersion> <hiveVersion>string</hiveVersion> <pigVersion>string</pigVersion> <installOozie>true</installOozie> <customBootstrapActionMaster> <scriptDefinition> <scriptName>string</scriptName> <scriptLocation>string</scriptLocation> <scriptArguments> <argument>string</argument> </scriptArguments> </scriptDefinition> </customBootstrapActionMaster> <customBootstrapActionAll> <scriptDefinition> <scriptName>string</scriptName> <scriptLocation>string</scriptLocation> <scriptArguments> <argument>string</argument> </scriptArguments> </scriptDefinition> </customBootstrapActionAll> <additionalInfo>string</additionalInfo> <instanceDefinitions> <masterInstances> <instanceCount>0</instanceCount> <instanceType>string</instanceType> <instanceSpotPrice>0</instanceSpotPrice> <instanceMaxSearchPrice>0</instanceMaxSearchPrice> <instanceOnDemandThreshold>0</instanceOnDemandThreshold> </masterInstances> <coreInstances> <instanceCount>0</instanceCount> <instanceType>string</instanceType> <instanceSpotPrice>0</instanceSpotPrice> <instanceMaxSearchPrice>0</instanceMaxSearchPrice> <instanceOnDemandThreshold>0</instanceOnDemandThreshold> </coreInstances> <taskInstances> <instanceCount>0</instanceCount> <instanceType>string</instanceType> <instanceSpotPrice>0</instanceSpotPrice> <instanceMaxSearchPrice>0</instanceMaxSearchPrice> <instanceOnDemandThreshold>0</instanceOnDemandThreshold> </taskInstances> </instanceDefinitions> <nodeTags> <nodeTag> <tagName>string</tagName> <tagValue>string</tagValue> </nodeTag> </nodeTags> <supportedProduct>string</supportedProduct> <applications> <application> <name>string</name> <version>string</version> <args> <arg>string</arg> </args> <additionalInfoList> <additionalInfo> <name>string</name> <value>string</value> </additionalInfo> </additionalInfoList> </application> </applications> <configurations> <configuration> <classification>string</classification> <configurations> <configuration/> </configurations> <properties> <property> <name>string</name> <value>string</value> </property> </properties> </configuration> </configurations> <daemonConfigurations> <daemonParam> <name>string</name> <value>string</value> </daemonParam> </daemonConfigurations> <hadoopConfigurations/> <hadoopJarSteps> <hadoopJarStep> <stepName>string</stepName> <jarLocation>string</jarLocation> <mainClass>string</mainClass> <scriptArguments> <argument>string</argument> </scriptArguments> <continueOnError>true</continueOnError> </hadoopJarStep> </hadoopJarSteps> <additionalMasterSecurityGroups> <additionalMasterSecurityGroup>string</additionalMasterSecurityGroup> </additionalMasterSecurityGroups> <additionalSlaveSecurityGroups> <additionalSlaveSecurityGroup>string</additionalSlaveSecurityGroup> </additionalSlaveSecurityGroups> </emrClusterDefinition> </emrClusterDefinitionCreateRequest> Click to set as parameter value

Response (Status 200)

emrClusterDefinitionInformation {

id (integer, optional),

emrClusterDefinitionKey (emrClusterDefinitionKey),

emrClusterDefinition (emrClusterDefinition)

}
emrClusterDefinitionKey {

namespace (string):

The namespace of the EMR cluster definition

,

emrClusterDefinitionName (string):

The name of the EMR cluster definition

}
emrClusterDefinition {

sshKeyPairName (string, optional):

The name of the Amazon EC2 key pair to set as the connection credential

,

subnetId (string, optional):

A comma separated list of Amazon VPC subnets.

When multiple subnets are specified, the subnet in the AZ with the best price will be used.
When multiple subnets belong to the same AZ, the subnet with the largest amount of available IP's will be used.

Cross-VPC access in PROD will only accept internal/emr subnets at this time.

,

logBucket (string, optional):

Amazon S3 bucket to receive log files

,

keepAlive (boolean, optional):

Launch a cluster that continues running even after completing all its steps

,

visibleToAll (boolean, optional):

Makes the instances in an existing cluster visible to all IAM users

,

terminationProtection (boolean, optional):

Launch the cluster with termination protection enabled

,

encryptionEnabled (boolean, optional):

Volume level encryption for the disks (using custom scripts). Encryption is not supported for AMI versions lower than 3.1.0

,

serviceIamRole (string, optional):

Launches the Amazon EMR service with the specified IAM role

,

ec2NodeIamProfileName (string, optional):

Launches the EC2 instances of a cluster with the specified IAM role

,

amiVersion (string, optional):

Specify the version of the AMI to use

,

releaseLabel (string, optional):

The release label. Available from 4.x

,

hadoopVersion (string, optional):

Specify the version of Hadoop to install

,

hiveVersion (string, optional):

The Hive version to load

,

pigVersion (string, optional):

The Pig version to load

,

installOozie (boolean, optional),

customBootstrapActionMaster (Array[scriptDefinition], optional):

Bootstrapping scripts that are executed only on the Master node

,

customBootstrapActionAll (Array[scriptDefinition], optional):

Bootstrapping scripts that are executed on all the nodes

,

additionalInfo (string, optional):

Specifies additional information during cluster creation

,

instanceDefinitions (instanceDefinitions, optional):

Instance Group Definitions

,

nodeTags (Array[nodeTag], optional):

Custom tags to be applied on the EC2 nodes

,

supportedProduct (string, optional):

Installs third-party software on an Amazon EMR cluster

,

applications (Array[emrClusterDefinitionApplication], optional):

List of applications

,

configurations (Array[emrClusterDefinitionConfiguration], optional):

List of configurations

,

daemonConfigurations (Array[parameter], optional):

Predefined bootstrap action to configure hadoop daemons

,

hadoopConfigurations (Array[string], optional):

Predefined bootstrap action to specify hadoop configurations

,

hadoopJarSteps (Array[hadoopJarStep], optional):

Hadoop jar steps that are added, to be executed once the cluster is started

,

additionalMasterSecurityGroups (Array[string], optional):

List of additional master node security groups. The security group defined by the configuration value emr.herd.support.security.group will automatically be added whether this list is specified or not

,

additionalSlaveSecurityGroups (Array[string], optional):

List of additional slave node security groups

}
scriptDefinition {

scriptName (string),

scriptLocation (string),

scriptArguments (Array[string], optional)

}
instanceDefinitions {

masterInstances (masterInstanceDefinition, optional),

coreInstances (instanceDefinition, optional),

taskInstances (instanceDefinition, optional)

}
nodeTag {

tagName (string),

tagValue (string)

}
emrClusterDefinitionApplication {

name (string, optional):

Application name

,

version (string, optional):

Application version

,

args (Array[string], optional):

List of arguments

,

additionalInfoList (Array[parameter], optional):

List of additional info

}
emrClusterDefinitionConfiguration {

classification (string, optional):

The configuration classification

,

configurations (Array[emrClusterDefinitionConfiguration], optional):

List of configurations

,

properties (Array[parameter], optional):

List of properties

}
parameter {

name (string):

              Name of the parameter

,

value (string, optional):

              Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the
              application logs

}
hadoopJarStep {

stepName (string),

jarLocation (string),

mainClass (string, optional),

scriptArguments (Array[string], optional),

continueOnError (boolean, optional)

}
masterInstanceDefinition {

instanceCount (integer, optional),

instanceType (string),

instanceSpotPrice (number, optional):

The instance bid price, in USD. If not specified, uses on-demand

,

instanceMaxSearchPrice (number, optional):

The maximum amount, in USD, to search for the best price. The best price search will only search for prices lower than this value. If a spot instance is selected by the search, this value will be the bid price

,

instanceOnDemandThreshold (number, optional):

The amount, in USD, you are willing to pay over the lowest spot price for an on-demand instance. Use this to dynamically balance the cost vs. stability of your instances.

If not specified, the search will not attempt to find an on-demand instance when a spot is found. This is the same behavior as when this parameter is set to $0.

}
instanceDefinition {

instanceCount (integer, optional),

instanceType (string),

instanceSpotPrice (number, optional),

instanceMaxSearchPrice (number, optional):

The maximum amount, in USD, to search for the best price. The best price search will only search for prices lower than this value. If a spot instance is selected by the search, this value will be the bid price.

,

instanceOnDemandThreshold (number, optional):

The amount, in USD, you are willing to pay over the lowest spot price for an on-demand instance. Use this to dynamically balance the cost vs. stability of your instances.

If not specified, the search will not attempt to find an on-demand instance when a spot is found. This is the same behavior as when this parameter is set to $0.

}

{
  "id": 0,
  "emrClusterDefinitionKey": {
    "namespace": "string",
    "emrClusterDefinitionName": "string"
  },
  "emrClusterDefinition": {
    "sshKeyPairName": "string",
    "subnetId": "string",
    "logBucket": "string",
    "keepAlive": true,
    "visibleToAll": true,
    "terminationProtection": true,
    "encryptionEnabled": true,
    "serviceIamRole": "string",
    "ec2NodeIamProfileName": "string",
    "amiVersion": "string",
    "releaseLabel": "string",
    "hadoopVersion": "string",
    "hiveVersion": "string",
    "pigVersion": "string",
    "installOozie": true,
    "customBootstrapActionMaster": [
      {
        "scriptName": "string",
        "scriptLocation": "string",
        "scriptArguments": [
          "string"
        ]
      }
    ],
    "customBootstrapActionAll": [
      {
        "scriptName": "string",
        "scriptLocation": "string",
        "scriptArguments": [
          "string"
        ]
      }
    ],
    "additionalInfo": "string",
    "instanceDefinitions": {
      "masterInstances": {
        "instanceCount": 0,
        "instanceType": "string",
        "instanceSpotPrice": 0,
        "instanceMaxSearchPrice": 0,
        "instanceOnDemandThreshold": 0
      },
      "coreInstances": {
        "instanceCount": 0,
        "instanceType": "string",
        "instanceSpotPrice": 0,
        "instanceMaxSearchPrice": 0,
        "instanceOnDemandThreshold": 0
      },
      "taskInstances": {
        "instanceCount": 0,
        "instanceType": "string",
        "instanceSpotPrice": 0,
        "instanceMaxSearchPrice": 0,
        "instanceOnDemandThreshold": 0
      }
    },
    "nodeTags": [
      {
        "tagName": "string",
        "tagValue": "string"
      }
    ],
    "supportedProduct": "string",
    "applications": [
      {
        "name": "string",
        "version": "string",
        "args": [
          "string"
        ],
        "additionalInfoList": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "configurations": [
      {
        "classification": "string",
        "configurations": [
          {}
        ],
        "properties": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "daemonConfigurations": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "hadoopConfigurations": [
      "string"
    ],
    "hadoopJarSteps": [
      {
        "stepName": "string",
        "jarLocation": "string",
        "mainClass": "string",
        "scriptArguments": [
          "string"
        ],
        "continueOnError": true
      }
    ],
    "additionalMasterSecurityGroups": [
      "string"
    ],
    "additionalSlaveSecurityGroups": [
      "string"
    ]
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<emrClusterDefinitionInformation>
     <id>0</id>
     <emrClusterDefinitionKey>
          <namespace>string</namespace>
          <emrClusterDefinitionName>string</emrClusterDefinitionName>
     </emrClusterDefinitionKey>
     <emrClusterDefinition>
          <sshKeyPairName>string</sshKeyPairName>
          <subnetId>string</subnetId>
          <logBucket>string</logBucket>
          <keepAlive>true</keepAlive>
          <visibleToAll>true</visibleToAll>
          <terminationProtection>true</terminationProtection>
          <encryptionEnabled>true</encryptionEnabled>
          <serviceIamRole>string</serviceIamRole>
          <ec2NodeIamProfileName>string</ec2NodeIamProfileName>
          <amiVersion>string</amiVersion>
          <releaseLabel>string</releaseLabel>
          <hadoopVersion>string</hadoopVersion>
          <hiveVersion>string</hiveVersion>
          <pigVersion>string</pigVersion>
          <installOozie>true</installOozie>
          <customBootstrapActionMaster>
               <scriptDefinition>
                    <scriptName>string</scriptName>
                    <scriptLocation>string</scriptLocation>
                    <scriptArguments>
                         <argument>string</argument>
                    </scriptArguments>
               </scriptDefinition>
          </customBootstrapActionMaster>
          <customBootstrapActionAll>
               <scriptDefinition>
                    <scriptName>string</scriptName>
                    <scriptLocation>string</scriptLocation>
                    <scriptArguments>
                         <argument>string</argument>
                    </scriptArguments>
               </scriptDefinition>
          </customBootstrapActionAll>
          <additionalInfo>string</additionalInfo>
          <instanceDefinitions>
               <masterInstances>
                    <instanceCount>0</instanceCount>
                    <instanceType>string</instanceType>
                    <instanceSpotPrice>0</instanceSpotPrice>
                    <instanceMaxSearchPrice>0</instanceMaxSearchPrice>
                    <instanceOnDemandThreshold>0</instanceOnDemandThreshold>
               </masterInstances>
               <coreInstances>
                    <instanceCount>0</instanceCount>
                    <instanceType>string</instanceType>
                    <instanceSpotPrice>0</instanceSpotPrice>
                    <instanceMaxSearchPrice>0</instanceMaxSearchPrice>
                    <instanceOnDemandThreshold>0</instanceOnDemandThreshold>
               </coreInstances>
               <taskInstances>
                    <instanceCount>0</instanceCount>
                    <instanceType>string</instanceType>
                    <instanceSpotPrice>0</instanceSpotPrice>
                    <instanceMaxSearchPrice>0</instanceMaxSearchPrice>
                    <instanceOnDemandThreshold>0</instanceOnDemandThreshold>
               </taskInstances>
          </instanceDefinitions>
          <nodeTags>
               <nodeTag>
                    <tagName>string</tagName>
                    <tagValue>string</tagValue>
               </nodeTag>
          </nodeTags>
          <supportedProduct>string</supportedProduct>
          <applications>
               <application>
                    <name>string</name>
                    <version>string</version>
                    <args>
                         <arg>string</arg>
                    </args>
                    <additionalInfoList>
                         <additionalInfo>
                              <name>string</name>
                              <value>string</value>
                         </additionalInfo>
                    </additionalInfoList>
               </application>
          </applications>
          <configurations>
               <configuration>
                    <classification>string</classification>
                    <configurations>
                         <configuration/>
                    </configurations>
                    <properties>
                         <property>
                              <name>string</name>
                              <value>string</value>
                         </property>
                    </properties>
               </configuration>
          </configurations>
          <daemonConfigurations>
               <daemonParam>
                    <name>string</name>
                    <value>string</value>
               </daemonParam>
          </daemonConfigurations>
          <hadoopConfigurations/>
          <hadoopJarSteps>
               <hadoopJarStep>
                    <stepName>string</stepName>
                    <jarLocation>string</jarLocation>
                    <mainClass>string</mainClass>
                    <scriptArguments>
                         <argument>string</argument>
                    </scriptArguments>
                    <continueOnError>true</continueOnError>
               </hadoopJarStep>
          </hadoopJarSteps>
          <additionalMasterSecurityGroups>
               <additionalMasterSecurityGroup>string</additionalMasterSecurityGroup>
          </additionalMasterSecurityGroups>
          <additionalSlaveSecurityGroups>
               <additionalSlaveSecurityGroup>string</additionalSlaveSecurityGroup>
          </additionalSlaveSecurityGroups>
     </emrClusterDefinition>
</emrClusterDefinitionInformation>

Response Content Type

get /emrClusterDefinitions/namespaces/{namespace}

getEmrClusterDefinitions

delete /emrClusterDefinitions/namespaces/{namespace}/emrClusterDefinitionNames/{emrClusterDefinitionName}

deleteEmrClusterDefinition

Implementation Notes

Deletes an existing EMR cluster definition by namespace and name.

Requires WRITE permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace	path	string
emrClusterDefinitionName		the EMR cluster definition name	path	string

Response (Status 200)

emrClusterDefinitionInformation {

id (integer, optional),

emrClusterDefinitionKey (emrClusterDefinitionKey),

emrClusterDefinition (emrClusterDefinition)

}
emrClusterDefinitionKey {

namespace (string):

The namespace of the EMR cluster definition

,

emrClusterDefinitionName (string):

The name of the EMR cluster definition

}
emrClusterDefinition {

sshKeyPairName (string, optional):

The name of the Amazon EC2 key pair to set as the connection credential

,

subnetId (string, optional):

A comma separated list of Amazon VPC subnets.

When multiple subnets are specified, the subnet in the AZ with the best price will be used.
When multiple subnets belong to the same AZ, the subnet with the largest amount of available IP's will be used.

Cross-VPC access in PROD will only accept internal/emr subnets at this time.

,

logBucket (string, optional):

Amazon S3 bucket to receive log files

,

keepAlive (boolean, optional):

Launch a cluster that continues running even after completing all its steps

,

visibleToAll (boolean, optional):

Makes the instances in an existing cluster visible to all IAM users

,

terminationProtection (boolean, optional):

Launch the cluster with termination protection enabled

,

encryptionEnabled (boolean, optional):

Volume level encryption for the disks (using custom scripts). Encryption is not supported for AMI versions lower than 3.1.0

,

serviceIamRole (string, optional):

Launches the Amazon EMR service with the specified IAM role

,

ec2NodeIamProfileName (string, optional):

Launches the EC2 instances of a cluster with the specified IAM role

,

amiVersion (string, optional):

Specify the version of the AMI to use

,

releaseLabel (string, optional):

The release label. Available from 4.x

,

hadoopVersion (string, optional):

Specify the version of Hadoop to install

,

hiveVersion (string, optional):

The Hive version to load

,

pigVersion (string, optional):

The Pig version to load

,

installOozie (boolean, optional),

customBootstrapActionMaster (Array[scriptDefinition], optional):

Bootstrapping scripts that are executed only on the Master node

,

customBootstrapActionAll (Array[scriptDefinition], optional):

Bootstrapping scripts that are executed on all the nodes

,

additionalInfo (string, optional):

Specifies additional information during cluster creation

,

instanceDefinitions (instanceDefinitions, optional):

Instance Group Definitions

,

nodeTags (Array[nodeTag], optional):

Custom tags to be applied on the EC2 nodes

,

supportedProduct (string, optional):

Installs third-party software on an Amazon EMR cluster

,

applications (Array[emrClusterDefinitionApplication], optional):

List of applications

,

configurations (Array[emrClusterDefinitionConfiguration], optional):

List of configurations

,

daemonConfigurations (Array[parameter], optional):

Predefined bootstrap action to configure hadoop daemons

,

hadoopConfigurations (Array[string], optional):

Predefined bootstrap action to specify hadoop configurations

,

hadoopJarSteps (Array[hadoopJarStep], optional):

Hadoop jar steps that are added, to be executed once the cluster is started

,

additionalMasterSecurityGroups (Array[string], optional):

List of additional master node security groups. The security group defined by the configuration value emr.herd.support.security.group will automatically be added whether this list is specified or not

,

additionalSlaveSecurityGroups (Array[string], optional):

List of additional slave node security groups

}
scriptDefinition {

scriptName (string),

scriptLocation (string),

scriptArguments (Array[string], optional)

}
instanceDefinitions {

masterInstances (masterInstanceDefinition, optional),

coreInstances (instanceDefinition, optional),

taskInstances (instanceDefinition, optional)

}
nodeTag {

tagName (string),

tagValue (string)

}
emrClusterDefinitionApplication {

name (string, optional):

Application name

,

version (string, optional):

Application version

,

args (Array[string], optional):

List of arguments

,

additionalInfoList (Array[parameter], optional):

List of additional info

}
emrClusterDefinitionConfiguration {

classification (string, optional):

The configuration classification

,

configurations (Array[emrClusterDefinitionConfiguration], optional):

List of configurations

,

properties (Array[parameter], optional):

List of properties

}
parameter {

name (string):

              Name of the parameter

,

value (string, optional):

              Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the
              application logs

}
hadoopJarStep {

stepName (string),

jarLocation (string),

mainClass (string, optional),

scriptArguments (Array[string], optional),

continueOnError (boolean, optional)

}
masterInstanceDefinition {

instanceCount (integer, optional),

instanceType (string),

instanceSpotPrice (number, optional):

The instance bid price, in USD. If not specified, uses on-demand

,

instanceMaxSearchPrice (number, optional):

The maximum amount, in USD, to search for the best price. The best price search will only search for prices lower than this value. If a spot instance is selected by the search, this value will be the bid price

,

instanceOnDemandThreshold (number, optional):

The amount, in USD, you are willing to pay over the lowest spot price for an on-demand instance. Use this to dynamically balance the cost vs. stability of your instances.

If not specified, the search will not attempt to find an on-demand instance when a spot is found. This is the same behavior as when this parameter is set to $0.

}
instanceDefinition {

instanceCount (integer, optional),

instanceType (string),

instanceSpotPrice (number, optional),

instanceMaxSearchPrice (number, optional):

The maximum amount, in USD, to search for the best price. The best price search will only search for prices lower than this value. If a spot instance is selected by the search, this value will be the bid price.

,

instanceOnDemandThreshold (number, optional):

The amount, in USD, you are willing to pay over the lowest spot price for an on-demand instance. Use this to dynamically balance the cost vs. stability of your instances.

If not specified, the search will not attempt to find an on-demand instance when a spot is found. This is the same behavior as when this parameter is set to $0.

}

{
  "id": 0,
  "emrClusterDefinitionKey": {
    "namespace": "string",
    "emrClusterDefinitionName": "string"
  },
  "emrClusterDefinition": {
    "sshKeyPairName": "string",
    "subnetId": "string",
    "logBucket": "string",
    "keepAlive": true,
    "visibleToAll": true,
    "terminationProtection": true,
    "encryptionEnabled": true,
    "serviceIamRole": "string",
    "ec2NodeIamProfileName": "string",
    "amiVersion": "string",
    "releaseLabel": "string",
    "hadoopVersion": "string",
    "hiveVersion": "string",
    "pigVersion": "string",
    "installOozie": true,
    "customBootstrapActionMaster": [
      {
        "scriptName": "string",
        "scriptLocation": "string",
        "scriptArguments": [
          "string"
        ]
      }
    ],
    "customBootstrapActionAll": [
      {
        "scriptName": "string",
        "scriptLocation": "string",
        "scriptArguments": [
          "string"
        ]
      }
    ],
    "additionalInfo": "string",
    "instanceDefinitions": {
      "masterInstances": {
        "instanceCount": 0,
        "instanceType": "string",
        "instanceSpotPrice": 0,
        "instanceMaxSearchPrice": 0,
        "instanceOnDemandThreshold": 0
      },
      "coreInstances": {
        "instanceCount": 0,
        "instanceType": "string",
        "instanceSpotPrice": 0,
        "instanceMaxSearchPrice": 0,
        "instanceOnDemandThreshold": 0
      },
      "taskInstances": {
        "instanceCount": 0,
        "instanceType": "string",
        "instanceSpotPrice": 0,
        "instanceMaxSearchPrice": 0,
        "instanceOnDemandThreshold": 0
      }
    },
    "nodeTags": [
      {
        "tagName": "string",
        "tagValue": "string"
      }
    ],
    "supportedProduct": "string",
    "applications": [
      {
        "name": "string",
        "version": "string",
        "args": [
          "string"
        ],
        "additionalInfoList": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "configurations": [
      {
        "classification": "string",
        "configurations": [
          {}
        ],
        "properties": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "daemonConfigurations": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "hadoopConfigurations": [
      "string"
    ],
    "hadoopJarSteps": [
      {
        "stepName": "string",
        "jarLocation": "string",
        "mainClass": "string",
        "scriptArguments": [
          "string"
        ],
        "continueOnError": true
      }
    ],
    "additionalMasterSecurityGroups": [
      "string"
    ],
    "additionalSlaveSecurityGroups": [
      "string"
    ]
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<emrClusterDefinitionInformation>
     <id>0</id>
     <emrClusterDefinitionKey>
          <namespace>string</namespace>
          <emrClusterDefinitionName>string</emrClusterDefinitionName>
     </emrClusterDefinitionKey>
     <emrClusterDefinition>
          <sshKeyPairName>string</sshKeyPairName>
          <subnetId>string</subnetId>
          <logBucket>string</logBucket>
          <keepAlive>true</keepAlive>
          <visibleToAll>true</visibleToAll>
          <terminationProtection>true</terminationProtection>
          <encryptionEnabled>true</encryptionEnabled>
          <serviceIamRole>string</serviceIamRole>
          <ec2NodeIamProfileName>string</ec2NodeIamProfileName>
          <amiVersion>string</amiVersion>
          <releaseLabel>string</releaseLabel>
          <hadoopVersion>string</hadoopVersion>
          <hiveVersion>string</hiveVersion>
          <pigVersion>string</pigVersion>
          <installOozie>true</installOozie>
          <customBootstrapActionMaster>
               <scriptDefinition>
                    <scriptName>string</scriptName>
                    <scriptLocation>string</scriptLocation>
                    <scriptArguments>
                         <argument>string</argument>
                    </scriptArguments>
               </scriptDefinition>
          </customBootstrapActionMaster>
          <customBootstrapActionAll>
               <scriptDefinition>
                    <scriptName>string</scriptName>
                    <scriptLocation>string</scriptLocation>
                    <scriptArguments>
                         <argument>string</argument>
                    </scriptArguments>
               </scriptDefinition>
          </customBootstrapActionAll>
          <additionalInfo>string</additionalInfo>
          <instanceDefinitions>
               <masterInstances>
                    <instanceCount>0</instanceCount>
                    <instanceType>string</instanceType>
                    <instanceSpotPrice>0</instanceSpotPrice>
                    <instanceMaxSearchPrice>0</instanceMaxSearchPrice>
                    <instanceOnDemandThreshold>0</instanceOnDemandThreshold>
               </masterInstances>
               <coreInstances>
                    <instanceCount>0</instanceCount>
                    <instanceType>string</instanceType>
                    <instanceSpotPrice>0</instanceSpotPrice>
                    <instanceMaxSearchPrice>0</instanceMaxSearchPrice>
                    <instanceOnDemandThreshold>0</instanceOnDemandThreshold>
               </coreInstances>
               <taskInstances>
                    <instanceCount>0</instanceCount>
                    <instanceType>string</instanceType>
                    <instanceSpotPrice>0</instanceSpotPrice>
                    <instanceMaxSearchPrice>0</instanceMaxSearchPrice>
                    <instanceOnDemandThreshold>0</instanceOnDemandThreshold>
               </taskInstances>
          </instanceDefinitions>
          <nodeTags>
               <nodeTag>
                    <tagName>string</tagName>
                    <tagValue>string</tagValue>
               </nodeTag>
          </nodeTags>
          <supportedProduct>string</supportedProduct>
          <applications>
               <application>
                    <name>string</name>
                    <version>string</version>
                    <args>
                         <arg>string</arg>
                    </args>
                    <additionalInfoList>
                         <additionalInfo>
                              <name>string</name>
                              <value>string</value>
                         </additionalInfo>
                    </additionalInfoList>
               </application>
          </applications>
          <configurations>
               <configuration>
                    <classification>string</classification>
                    <configurations>
                         <configuration/>
                    </configurations>
                    <properties>
                         <property>
                              <name>string</name>
                              <value>string</value>
                         </property>
                    </properties>
               </configuration>
          </configurations>
          <daemonConfigurations>
               <daemonParam>
                    <name>string</name>
                    <value>string</value>
               </daemonParam>
          </daemonConfigurations>
          <hadoopConfigurations/>
          <hadoopJarSteps>
               <hadoopJarStep>
                    <stepName>string</stepName>
                    <jarLocation>string</jarLocation>
                    <mainClass>string</mainClass>
                    <scriptArguments>
                         <argument>string</argument>
                    </scriptArguments>
                    <continueOnError>true</continueOnError>
               </hadoopJarStep>
          </hadoopJarSteps>
          <additionalMasterSecurityGroups>
               <additionalMasterSecurityGroup>string</additionalMasterSecurityGroup>
          </additionalMasterSecurityGroups>
          <additionalSlaveSecurityGroups>
               <additionalSlaveSecurityGroup>string</additionalSlaveSecurityGroup>
          </additionalSlaveSecurityGroups>
     </emrClusterDefinition>
</emrClusterDefinitionInformation>

Response Content Type

get /emrClusterDefinitions/namespaces/{namespace}/emrClusterDefinitionNames/{emrClusterDefinitionName}

getEmrClusterDefinition

Implementation Notes

Gets an existing EMR cluster definition by namespace and name.

Requires READ permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace	path	string
emrClusterDefinitionName		the EMR cluster definition name	path	string

Response (Status 200)

emrClusterDefinitionInformation {

id (integer, optional),

emrClusterDefinitionKey (emrClusterDefinitionKey),

emrClusterDefinition (emrClusterDefinition)

}
emrClusterDefinitionKey {

namespace (string):

The namespace of the EMR cluster definition

,

emrClusterDefinitionName (string):

The name of the EMR cluster definition

}
emrClusterDefinition {

sshKeyPairName (string, optional):

The name of the Amazon EC2 key pair to set as the connection credential

,

subnetId (string, optional):

A comma separated list of Amazon VPC subnets.

When multiple subnets are specified, the subnet in the AZ with the best price will be used.
When multiple subnets belong to the same AZ, the subnet with the largest amount of available IP's will be used.

Cross-VPC access in PROD will only accept internal/emr subnets at this time.

,

logBucket (string, optional):

Amazon S3 bucket to receive log files

,

keepAlive (boolean, optional):

Launch a cluster that continues running even after completing all its steps

,

visibleToAll (boolean, optional):

Makes the instances in an existing cluster visible to all IAM users

,

terminationProtection (boolean, optional):

Launch the cluster with termination protection enabled

,

encryptionEnabled (boolean, optional):

Volume level encryption for the disks (using custom scripts). Encryption is not supported for AMI versions lower than 3.1.0

,

serviceIamRole (string, optional):

Launches the Amazon EMR service with the specified IAM role

,

ec2NodeIamProfileName (string, optional):

Launches the EC2 instances of a cluster with the specified IAM role

,

amiVersion (string, optional):

Specify the version of the AMI to use

,

releaseLabel (string, optional):

The release label. Available from 4.x

,

hadoopVersion (string, optional):

Specify the version of Hadoop to install

,

hiveVersion (string, optional):

The Hive version to load

,

pigVersion (string, optional):

The Pig version to load

,

installOozie (boolean, optional),

customBootstrapActionMaster (Array[scriptDefinition], optional):

Bootstrapping scripts that are executed only on the Master node

,

customBootstrapActionAll (Array[scriptDefinition], optional):

Bootstrapping scripts that are executed on all the nodes

,

additionalInfo (string, optional):

Specifies additional information during cluster creation

,

instanceDefinitions (instanceDefinitions, optional):

Instance Group Definitions

,

nodeTags (Array[nodeTag], optional):

Custom tags to be applied on the EC2 nodes

,

supportedProduct (string, optional):

Installs third-party software on an Amazon EMR cluster

,

applications (Array[emrClusterDefinitionApplication], optional):

List of applications

,

configurations (Array[emrClusterDefinitionConfiguration], optional):

List of configurations

,

daemonConfigurations (Array[parameter], optional):

Predefined bootstrap action to configure hadoop daemons

,

hadoopConfigurations (Array[string], optional):

Predefined bootstrap action to specify hadoop configurations

,

hadoopJarSteps (Array[hadoopJarStep], optional):

Hadoop jar steps that are added, to be executed once the cluster is started

,

additionalMasterSecurityGroups (Array[string], optional):

List of additional master node security groups. The security group defined by the configuration value emr.herd.support.security.group will automatically be added whether this list is specified or not

,

additionalSlaveSecurityGroups (Array[string], optional):

List of additional slave node security groups

}
scriptDefinition {

scriptName (string),

scriptLocation (string),

scriptArguments (Array[string], optional)

}
instanceDefinitions {

masterInstances (masterInstanceDefinition, optional),

coreInstances (instanceDefinition, optional),

taskInstances (instanceDefinition, optional)

}
nodeTag {

tagName (string),

tagValue (string)

}
emrClusterDefinitionApplication {

name (string, optional):

Application name

,

version (string, optional):

Application version

,

args (Array[string], optional):

List of arguments

,

additionalInfoList (Array[parameter], optional):

List of additional info

}
emrClusterDefinitionConfiguration {

classification (string, optional):

The configuration classification

,

configurations (Array[emrClusterDefinitionConfiguration], optional):

List of configurations

,

properties (Array[parameter], optional):

List of properties

}
parameter {

name (string):

              Name of the parameter

,

value (string, optional):

              Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the
              application logs

}
hadoopJarStep {

stepName (string),

jarLocation (string),

mainClass (string, optional),

scriptArguments (Array[string], optional),

continueOnError (boolean, optional)

}
masterInstanceDefinition {

instanceCount (integer, optional),

instanceType (string),

instanceSpotPrice (number, optional):

The instance bid price, in USD. If not specified, uses on-demand

,

instanceMaxSearchPrice (number, optional):

The maximum amount, in USD, to search for the best price. The best price search will only search for prices lower than this value. If a spot instance is selected by the search, this value will be the bid price

,

instanceOnDemandThreshold (number, optional):

The amount, in USD, you are willing to pay over the lowest spot price for an on-demand instance. Use this to dynamically balance the cost vs. stability of your instances.

If not specified, the search will not attempt to find an on-demand instance when a spot is found. This is the same behavior as when this parameter is set to $0.

}
instanceDefinition {

instanceCount (integer, optional),

instanceType (string),

instanceSpotPrice (number, optional),

instanceMaxSearchPrice (number, optional):

The maximum amount, in USD, to search for the best price. The best price search will only search for prices lower than this value. If a spot instance is selected by the search, this value will be the bid price.

,

instanceOnDemandThreshold (number, optional):

The amount, in USD, you are willing to pay over the lowest spot price for an on-demand instance. Use this to dynamically balance the cost vs. stability of your instances.

If not specified, the search will not attempt to find an on-demand instance when a spot is found. This is the same behavior as when this parameter is set to $0.

}

{
  "id": 0,
  "emrClusterDefinitionKey": {
    "namespace": "string",
    "emrClusterDefinitionName": "string"
  },
  "emrClusterDefinition": {
    "sshKeyPairName": "string",
    "subnetId": "string",
    "logBucket": "string",
    "keepAlive": true,
    "visibleToAll": true,
    "terminationProtection": true,
    "encryptionEnabled": true,
    "serviceIamRole": "string",
    "ec2NodeIamProfileName": "string",
    "amiVersion": "string",
    "releaseLabel": "string",
    "hadoopVersion": "string",
    "hiveVersion": "string",
    "pigVersion": "string",
    "installOozie": true,
    "customBootstrapActionMaster": [
      {
        "scriptName": "string",
        "scriptLocation": "string",
        "scriptArguments": [
          "string"
        ]
      }
    ],
    "customBootstrapActionAll": [
      {
        "scriptName": "string",
        "scriptLocation": "string",
        "scriptArguments": [
          "string"
        ]
      }
    ],
    "additionalInfo": "string",
    "instanceDefinitions": {
      "masterInstances": {
        "instanceCount": 0,
        "instanceType": "string",
        "instanceSpotPrice": 0,
        "instanceMaxSearchPrice": 0,
        "instanceOnDemandThreshold": 0
      },
      "coreInstances": {
        "instanceCount": 0,
        "instanceType": "string",
        "instanceSpotPrice": 0,
        "instanceMaxSearchPrice": 0,
        "instanceOnDemandThreshold": 0
      },
      "taskInstances": {
        "instanceCount": 0,
        "instanceType": "string",
        "instanceSpotPrice": 0,
        "instanceMaxSearchPrice": 0,
        "instanceOnDemandThreshold": 0
      }
    },
    "nodeTags": [
      {
        "tagName": "string",
        "tagValue": "string"
      }
    ],
    "supportedProduct": "string",
    "applications": [
      {
        "name": "string",
        "version": "string",
        "args": [
          "string"
        ],
        "additionalInfoList": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "configurations": [
      {
        "classification": "string",
        "configurations": [
          {}
        ],
        "properties": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "daemonConfigurations": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "hadoopConfigurations": [
      "string"
    ],
    "hadoopJarSteps": [
      {
        "stepName": "string",
        "jarLocation": "string",
        "mainClass": "string",
        "scriptArguments": [
          "string"
        ],
        "continueOnError": true
      }
    ],
    "additionalMasterSecurityGroups": [
      "string"
    ],
    "additionalSlaveSecurityGroups": [
      "string"
    ]
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<emrClusterDefinitionInformation>
     <id>0</id>
     <emrClusterDefinitionKey>
          <namespace>string</namespace>
          <emrClusterDefinitionName>string</emrClusterDefinitionName>
     </emrClusterDefinitionKey>
     <emrClusterDefinition>
          <sshKeyPairName>string</sshKeyPairName>
          <subnetId>string</subnetId>
          <logBucket>string</logBucket>
          <keepAlive>true</keepAlive>
          <visibleToAll>true</visibleToAll>
          <terminationProtection>true</terminationProtection>
          <encryptionEnabled>true</encryptionEnabled>
          <serviceIamRole>string</serviceIamRole>
          <ec2NodeIamProfileName>string</ec2NodeIamProfileName>
          <amiVersion>string</amiVersion>
          <releaseLabel>string</releaseLabel>
          <hadoopVersion>string</hadoopVersion>
          <hiveVersion>string</hiveVersion>
          <pigVersion>string</pigVersion>
          <installOozie>true</installOozie>
          <customBootstrapActionMaster>
               <scriptDefinition>
                    <scriptName>string</scriptName>
                    <scriptLocation>string</scriptLocation>
                    <scriptArguments>
                         <argument>string</argument>
                    </scriptArguments>
               </scriptDefinition>
          </customBootstrapActionMaster>
          <customBootstrapActionAll>
               <scriptDefinition>
                    <scriptName>string</scriptName>
                    <scriptLocation>string</scriptLocation>
                    <scriptArguments>
                         <argument>string</argument>
                    </scriptArguments>
               </scriptDefinition>
          </customBootstrapActionAll>
          <additionalInfo>string</additionalInfo>
          <instanceDefinitions>
               <masterInstances>
                    <instanceCount>0</instanceCount>
                    <instanceType>string</instanceType>
                    <instanceSpotPrice>0</instanceSpotPrice>
                    <instanceMaxSearchPrice>0</instanceMaxSearchPrice>
                    <instanceOnDemandThreshold>0</instanceOnDemandThreshold>
               </masterInstances>
               <coreInstances>
                    <instanceCount>0</instanceCount>
                    <instanceType>string</instanceType>
                    <instanceSpotPrice>0</instanceSpotPrice>
                    <instanceMaxSearchPrice>0</instanceMaxSearchPrice>
                    <instanceOnDemandThreshold>0</instanceOnDemandThreshold>
               </coreInstances>
               <taskInstances>
                    <instanceCount>0</instanceCount>
                    <instanceType>string</instanceType>
                    <instanceSpotPrice>0</instanceSpotPrice>
                    <instanceMaxSearchPrice>0</instanceMaxSearchPrice>
                    <instanceOnDemandThreshold>0</instanceOnDemandThreshold>
               </taskInstances>
          </instanceDefinitions>
          <nodeTags>
               <nodeTag>
                    <tagName>string</tagName>
                    <tagValue>string</tagValue>
               </nodeTag>
          </nodeTags>
          <supportedProduct>string</supportedProduct>
          <applications>
               <application>
                    <name>string</name>
                    <version>string</version>
                    <args>
                         <arg>string</arg>
                    </args>
                    <additionalInfoList>
                         <additionalInfo>
                              <name>string</name>
                              <value>string</value>
                         </additionalInfo>
                    </additionalInfoList>
               </application>
          </applications>
          <configurations>
               <configuration>
                    <classification>string</classification>
                    <configurations>
                         <configuration/>
                    </configurations>
                    <properties>
                         <property>
                              <name>string</name>
                              <value>string</value>
                         </property>
                    </properties>
               </configuration>
          </configurations>
          <daemonConfigurations>
               <daemonParam>
                    <name>string</name>
                    <value>string</value>
               </daemonParam>
          </daemonConfigurations>
          <hadoopConfigurations/>
          <hadoopJarSteps>
               <hadoopJarStep>
                    <stepName>string</stepName>
                    <jarLocation>string</jarLocation>
                    <mainClass>string</mainClass>
                    <scriptArguments>
                         <argument>string</argument>
                    </scriptArguments>
                    <continueOnError>true</continueOnError>
               </hadoopJarStep>
          </hadoopJarSteps>
          <additionalMasterSecurityGroups>
               <additionalMasterSecurityGroup>string</additionalMasterSecurityGroup>
          </additionalMasterSecurityGroups>
          <additionalSlaveSecurityGroups>
               <additionalSlaveSecurityGroup>string</additionalSlaveSecurityGroup>
          </additionalSlaveSecurityGroups>
     </emrClusterDefinition>
</emrClusterDefinitionInformation>

Response Content Type

put /emrClusterDefinitions/namespaces/{namespace}/emrClusterDefinitionNames/{emrClusterDefinitionName}

updateEmrClusterDefinition

Implementation Notes

Updates an existing EMR cluster definition by namespace and name.

Requires WRITE permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace	path	string
emrClusterDefinitionName		the EMR cluster definition name	path	string
emrClusterDefinitionUpdateRequest: the information needed to update the EMR cluster definition	Parameter content type: Model JSON Schema XML Example emrClusterDefinitionUpdateRequest { emrClusterDefinition (emrClusterDefinition) } emrClusterDefinition { sshKeyPairName (string, optional): The name of the Amazon EC2 key pair to set as the connection credential , subnetId (string, optional): A comma separated list of Amazon VPC subnets. When multiple subnets are specified, the subnet in the AZ with the best price will be used. When multiple subnets belong to the same AZ, the subnet with the largest amount of available IP's will be used. Cross-VPC access in PROD will only accept internal/emr subnets at this time. , logBucket (string, optional): Amazon S3 bucket to receive log files , keepAlive (boolean, optional): Launch a cluster that continues running even after completing all its steps , visibleToAll (boolean, optional): Makes the instances in an existing cluster visible to all IAM users , terminationProtection (boolean, optional): Launch the cluster with termination protection enabled , encryptionEnabled (boolean, optional): Volume level encryption for the disks (using custom scripts). Encryption is not supported for AMI versions lower than 3.1.0 , serviceIamRole (string, optional): Launches the Amazon EMR service with the specified IAM role , ec2NodeIamProfileName (string, optional): Launches the EC2 instances of a cluster with the specified IAM role , amiVersion (string, optional): Specify the version of the AMI to use , releaseLabel (string, optional): The release label. Available from 4.x , hadoopVersion (string, optional): Specify the version of Hadoop to install , hiveVersion (string, optional): The Hive version to load , pigVersion (string, optional): The Pig version to load , installOozie (boolean, optional), customBootstrapActionMaster (Array[scriptDefinition], optional): Bootstrapping scripts that are executed only on the Master node , customBootstrapActionAll (Array[scriptDefinition], optional): Bootstrapping scripts that are executed on all the nodes , additionalInfo (string, optional): Specifies additional information during cluster creation , instanceDefinitions (instanceDefinitions, optional): Instance Group Definitions , nodeTags (Array[nodeTag], optional): Custom tags to be applied on the EC2 nodes , supportedProduct (string, optional): Installs third-party software on an Amazon EMR cluster , applications (Array[emrClusterDefinitionApplication], optional): List of applications , configurations (Array[emrClusterDefinitionConfiguration], optional): List of configurations , daemonConfigurations (Array[parameter], optional): Predefined bootstrap action to configure hadoop daemons , hadoopConfigurations (Array[string], optional): Predefined bootstrap action to specify hadoop configurations , hadoopJarSteps (Array[hadoopJarStep], optional): Hadoop jar steps that are added, to be executed once the cluster is started , additionalMasterSecurityGroups (Array[string], optional): List of additional master node security groups. The security group defined by the configuration value emr.herd.support.security.group will automatically be added whether this list is specified or not , additionalSlaveSecurityGroups (Array[string], optional): List of additional slave node security groups } scriptDefinition { scriptName (string), scriptLocation (string), scriptArguments (Array[string], optional) } instanceDefinitions { masterInstances (masterInstanceDefinition, optional), coreInstances (instanceDefinition, optional), taskInstances (instanceDefinition, optional) } nodeTag { tagName (string), tagValue (string) } emrClusterDefinitionApplication { name (string, optional): Application name , version (string, optional): Application version , args (Array[string], optional): List of arguments , additionalInfoList (Array[parameter], optional): List of additional info } emrClusterDefinitionConfiguration { classification (string, optional): The configuration classification , configurations (Array[emrClusterDefinitionConfiguration], optional): List of configurations , properties (Array[parameter], optional): List of properties } parameter { name (string): `Name of the parameter` , value (string, optional): `Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the application logs` } hadoopJarStep { stepName (string), jarLocation (string), mainClass (string, optional), scriptArguments (Array[string], optional), continueOnError (boolean, optional) } masterInstanceDefinition { instanceCount (integer, optional), instanceType (string), instanceSpotPrice (number, optional): The instance bid price, in USD. If not specified, uses on-demand , instanceMaxSearchPrice (number, optional): The maximum amount, in USD, to search for the best price. The best price search will only search for prices lower than this value. If a spot instance is selected by the search, this value will be the bid price , instanceOnDemandThreshold (number, optional): The amount, in USD, you are willing to pay over the lowest spot price for an on-demand instance. Use this to dynamically balance the cost vs. stability of your instances. If not specified, the search will not attempt to find an on-demand instance when a spot is found. This is the same behavior as when this parameter is set to $0. } instanceDefinition { instanceCount (integer, optional), instanceType (string), instanceSpotPrice (number, optional), instanceMaxSearchPrice (number, optional): The maximum amount, in USD, to search for the best price. The best price search will only search for prices lower than this value. If a spot instance is selected by the search, this value will be the bid price. , instanceOnDemandThreshold (number, optional): The amount, in USD, you are willing to pay over the lowest spot price for an on-demand instance. Use this to dynamically balance the cost vs. stability of your instances. If not specified, the search will not attempt to find an on-demand instance when a spot is found. This is the same behavior as when this parameter is set to $0. } { "emrClusterDefinition": { "sshKeyPairName": "string", "subnetId": "string", "logBucket": "string", "keepAlive": true, "visibleToAll": true, "terminationProtection": true, "encryptionEnabled": true, "serviceIamRole": "string", "ec2NodeIamProfileName": "string", "amiVersion": "string", "releaseLabel": "string", "hadoopVersion": "string", "hiveVersion": "string", "pigVersion": "string", "installOozie": true, "customBootstrapActionMaster": [ { "scriptName": "string", "scriptLocation": "string", "scriptArguments": [ "string" ] } ], "customBootstrapActionAll": [ { "scriptName": "string", "scriptLocation": "string", "scriptArguments": [ "string" ] } ], "additionalInfo": "string", "instanceDefinitions": { "masterInstances": { "instanceCount": 0, "instanceType": "string", "instanceSpotPrice": 0, "instanceMaxSearchPrice": 0, "instanceOnDemandThreshold": 0 }, "coreInstances": { "instanceCount": 0, "instanceType": "string", "instanceSpotPrice": 0, "instanceMaxSearchPrice": 0, "instanceOnDemandThreshold": 0 }, "taskInstances": { "instanceCount": 0, "instanceType": "string", "instanceSpotPrice": 0, "instanceMaxSearchPrice": 0, "instanceOnDemandThreshold": 0 } }, "nodeTags": [ { "tagName": "string", "tagValue": "string" } ], "supportedProduct": "string", "applications": [ { "name": "string", "version": "string", "args": [ "string" ], "additionalInfoList": [ { "name": "string", "value": "string" } ] } ], "configurations": [ { "classification": "string", "configurations": [ {} ], "properties": [ { "name": "string", "value": "string" } ] } ], "daemonConfigurations": [ { "name": "string", "value": "string" } ], "hadoopConfigurations": [ "string" ], "hadoopJarSteps": [ { "stepName": "string", "jarLocation": "string", "mainClass": "string", "scriptArguments": [ "string" ], "continueOnError": true } ], "additionalMasterSecurityGroups": [ "string" ], "additionalSlaveSecurityGroups": [ "string" ] } } Click to set as parameter value <?xml version="1.0" encoding="UTF-8"?> <emrClusterDefinitionUpdateRequest> <emrClusterDefinition> <sshKeyPairName>string</sshKeyPairName> <subnetId>string</subnetId> <logBucket>string</logBucket> <keepAlive>true</keepAlive> <visibleToAll>true</visibleToAll> <terminationProtection>true</terminationProtection> <encryptionEnabled>true</encryptionEnabled> <serviceIamRole>string</serviceIamRole> <ec2NodeIamProfileName>string</ec2NodeIamProfileName> <amiVersion>string</amiVersion> <releaseLabel>string</releaseLabel> <hadoopVersion>string</hadoopVersion> <hiveVersion>string</hiveVersion> <pigVersion>string</pigVersion> <installOozie>true</installOozie> <customBootstrapActionMaster> <scriptDefinition> <scriptName>string</scriptName> <scriptLocation>string</scriptLocation> <scriptArguments> <argument>string</argument> </scriptArguments> </scriptDefinition> </customBootstrapActionMaster> <customBootstrapActionAll> <scriptDefinition> <scriptName>string</scriptName> <scriptLocation>string</scriptLocation> <scriptArguments> <argument>string</argument> </scriptArguments> </scriptDefinition> </customBootstrapActionAll> <additionalInfo>string</additionalInfo> <instanceDefinitions> <masterInstances> <instanceCount>0</instanceCount> <instanceType>string</instanceType> <instanceSpotPrice>0</instanceSpotPrice> <instanceMaxSearchPrice>0</instanceMaxSearchPrice> <instanceOnDemandThreshold>0</instanceOnDemandThreshold> </masterInstances> <coreInstances> <instanceCount>0</instanceCount> <instanceType>string</instanceType> <instanceSpotPrice>0</instanceSpotPrice> <instanceMaxSearchPrice>0</instanceMaxSearchPrice> <instanceOnDemandThreshold>0</instanceOnDemandThreshold> </coreInstances> <taskInstances> <instanceCount>0</instanceCount> <instanceType>string</instanceType> <instanceSpotPrice>0</instanceSpotPrice> <instanceMaxSearchPrice>0</instanceMaxSearchPrice> <instanceOnDemandThreshold>0</instanceOnDemandThreshold> </taskInstances> </instanceDefinitions> <nodeTags> <nodeTag> <tagName>string</tagName> <tagValue>string</tagValue> </nodeTag> </nodeTags> <supportedProduct>string</supportedProduct> <applications> <application> <name>string</name> <version>string</version> <args> <arg>string</arg> </args> <additionalInfoList> <additionalInfo> <name>string</name> <value>string</value> </additionalInfo> </additionalInfoList> </application> </applications> <configurations> <configuration> <classification>string</classification> <configurations> <configuration/> </configurations> <properties> <property> <name>string</name> <value>string</value> </property> </properties> </configuration> </configurations> <daemonConfigurations> <daemonParam> <name>string</name> <value>string</value> </daemonParam> </daemonConfigurations> <hadoopConfigurations/> <hadoopJarSteps> <hadoopJarStep> <stepName>string</stepName> <jarLocation>string</jarLocation> <mainClass>string</mainClass> <scriptArguments> <argument>string</argument> </scriptArguments> <continueOnError>true</continueOnError> </hadoopJarStep> </hadoopJarSteps> <additionalMasterSecurityGroups> <additionalMasterSecurityGroup>string</additionalMasterSecurityGroup> </additionalMasterSecurityGroups> <additionalSlaveSecurityGroups> <additionalSlaveSecurityGroup>string</additionalSlaveSecurityGroup> </additionalSlaveSecurityGroups> </emrClusterDefinition> </emrClusterDefinitionUpdateRequest> Click to set as parameter value

Response (Status 200)

emrClusterDefinitionInformation {

id (integer, optional),

emrClusterDefinitionKey (emrClusterDefinitionKey),

emrClusterDefinition (emrClusterDefinition)

}
emrClusterDefinitionKey {

namespace (string):

The namespace of the EMR cluster definition

,

emrClusterDefinitionName (string):

The name of the EMR cluster definition

}
emrClusterDefinition {

sshKeyPairName (string, optional):

The name of the Amazon EC2 key pair to set as the connection credential

,

subnetId (string, optional):

A comma separated list of Amazon VPC subnets.

When multiple subnets are specified, the subnet in the AZ with the best price will be used.
When multiple subnets belong to the same AZ, the subnet with the largest amount of available IP's will be used.

Cross-VPC access in PROD will only accept internal/emr subnets at this time.

,

logBucket (string, optional):

Amazon S3 bucket to receive log files

,

keepAlive (boolean, optional):

Launch a cluster that continues running even after completing all its steps

,

visibleToAll (boolean, optional):

Makes the instances in an existing cluster visible to all IAM users

,

terminationProtection (boolean, optional):

Launch the cluster with termination protection enabled

,

encryptionEnabled (boolean, optional):

Volume level encryption for the disks (using custom scripts). Encryption is not supported for AMI versions lower than 3.1.0

,

serviceIamRole (string, optional):

Launches the Amazon EMR service with the specified IAM role

,

ec2NodeIamProfileName (string, optional):

Launches the EC2 instances of a cluster with the specified IAM role

,

amiVersion (string, optional):

Specify the version of the AMI to use

,

releaseLabel (string, optional):

The release label. Available from 4.x

,

hadoopVersion (string, optional):

Specify the version of Hadoop to install

,

hiveVersion (string, optional):

The Hive version to load

,

pigVersion (string, optional):

The Pig version to load

,

installOozie (boolean, optional),

customBootstrapActionMaster (Array[scriptDefinition], optional):

Bootstrapping scripts that are executed only on the Master node

,

customBootstrapActionAll (Array[scriptDefinition], optional):

Bootstrapping scripts that are executed on all the nodes

,

additionalInfo (string, optional):

Specifies additional information during cluster creation

,

instanceDefinitions (instanceDefinitions, optional):

Instance Group Definitions

,

nodeTags (Array[nodeTag], optional):

Custom tags to be applied on the EC2 nodes

,

supportedProduct (string, optional):

Installs third-party software on an Amazon EMR cluster

,

applications (Array[emrClusterDefinitionApplication], optional):

List of applications

,

configurations (Array[emrClusterDefinitionConfiguration], optional):

List of configurations

,

daemonConfigurations (Array[parameter], optional):

Predefined bootstrap action to configure hadoop daemons

,

hadoopConfigurations (Array[string], optional):

Predefined bootstrap action to specify hadoop configurations

,

hadoopJarSteps (Array[hadoopJarStep], optional):

Hadoop jar steps that are added, to be executed once the cluster is started

,

additionalMasterSecurityGroups (Array[string], optional):

List of additional master node security groups. The security group defined by the configuration value emr.herd.support.security.group will automatically be added whether this list is specified or not

,

additionalSlaveSecurityGroups (Array[string], optional):

List of additional slave node security groups

}
scriptDefinition {

scriptName (string),

scriptLocation (string),

scriptArguments (Array[string], optional)

}
instanceDefinitions {

masterInstances (masterInstanceDefinition, optional),

coreInstances (instanceDefinition, optional),

taskInstances (instanceDefinition, optional)

}
nodeTag {

tagName (string),

tagValue (string)

}
emrClusterDefinitionApplication {

name (string, optional):

Application name

,

version (string, optional):

Application version

,

args (Array[string], optional):

List of arguments

,

additionalInfoList (Array[parameter], optional):

List of additional info

}
emrClusterDefinitionConfiguration {

classification (string, optional):

The configuration classification

,

configurations (Array[emrClusterDefinitionConfiguration], optional):

List of configurations

,

properties (Array[parameter], optional):

List of properties

}
parameter {

name (string):

              Name of the parameter

,

value (string, optional):

              Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the
              application logs

}
hadoopJarStep {

stepName (string),

jarLocation (string),

mainClass (string, optional),

scriptArguments (Array[string], optional),

continueOnError (boolean, optional)

}
masterInstanceDefinition {

instanceCount (integer, optional),

instanceType (string),

instanceSpotPrice (number, optional):

The instance bid price, in USD. If not specified, uses on-demand

,

instanceMaxSearchPrice (number, optional):

The maximum amount, in USD, to search for the best price. The best price search will only search for prices lower than this value. If a spot instance is selected by the search, this value will be the bid price

,

instanceOnDemandThreshold (number, optional):

The amount, in USD, you are willing to pay over the lowest spot price for an on-demand instance. Use this to dynamically balance the cost vs. stability of your instances.

If not specified, the search will not attempt to find an on-demand instance when a spot is found. This is the same behavior as when this parameter is set to $0.

}
instanceDefinition {

instanceCount (integer, optional),

instanceType (string),

instanceSpotPrice (number, optional),

instanceMaxSearchPrice (number, optional):

The maximum amount, in USD, to search for the best price. The best price search will only search for prices lower than this value. If a spot instance is selected by the search, this value will be the bid price.

,

instanceOnDemandThreshold (number, optional):

The amount, in USD, you are willing to pay over the lowest spot price for an on-demand instance. Use this to dynamically balance the cost vs. stability of your instances.

If not specified, the search will not attempt to find an on-demand instance when a spot is found. This is the same behavior as when this parameter is set to $0.

}

{
  "id": 0,
  "emrClusterDefinitionKey": {
    "namespace": "string",
    "emrClusterDefinitionName": "string"
  },
  "emrClusterDefinition": {
    "sshKeyPairName": "string",
    "subnetId": "string",
    "logBucket": "string",
    "keepAlive": true,
    "visibleToAll": true,
    "terminationProtection": true,
    "encryptionEnabled": true,
    "serviceIamRole": "string",
    "ec2NodeIamProfileName": "string",
    "amiVersion": "string",
    "releaseLabel": "string",
    "hadoopVersion": "string",
    "hiveVersion": "string",
    "pigVersion": "string",
    "installOozie": true,
    "customBootstrapActionMaster": [
      {
        "scriptName": "string",
        "scriptLocation": "string",
        "scriptArguments": [
          "string"
        ]
      }
    ],
    "customBootstrapActionAll": [
      {
        "scriptName": "string",
        "scriptLocation": "string",
        "scriptArguments": [
          "string"
        ]
      }
    ],
    "additionalInfo": "string",
    "instanceDefinitions": {
      "masterInstances": {
        "instanceCount": 0,
        "instanceType": "string",
        "instanceSpotPrice": 0,
        "instanceMaxSearchPrice": 0,
        "instanceOnDemandThreshold": 0
      },
      "coreInstances": {
        "instanceCount": 0,
        "instanceType": "string",
        "instanceSpotPrice": 0,
        "instanceMaxSearchPrice": 0,
        "instanceOnDemandThreshold": 0
      },
      "taskInstances": {
        "instanceCount": 0,
        "instanceType": "string",
        "instanceSpotPrice": 0,
        "instanceMaxSearchPrice": 0,
        "instanceOnDemandThreshold": 0
      }
    },
    "nodeTags": [
      {
        "tagName": "string",
        "tagValue": "string"
      }
    ],
    "supportedProduct": "string",
    "applications": [
      {
        "name": "string",
        "version": "string",
        "args": [
          "string"
        ],
        "additionalInfoList": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "configurations": [
      {
        "classification": "string",
        "configurations": [
          {}
        ],
        "properties": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "daemonConfigurations": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "hadoopConfigurations": [
      "string"
    ],
    "hadoopJarSteps": [
      {
        "stepName": "string",
        "jarLocation": "string",
        "mainClass": "string",
        "scriptArguments": [
          "string"
        ],
        "continueOnError": true
      }
    ],
    "additionalMasterSecurityGroups": [
      "string"
    ],
    "additionalSlaveSecurityGroups": [
      "string"
    ]
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<emrClusterDefinitionInformation>
     <id>0</id>
     <emrClusterDefinitionKey>
          <namespace>string</namespace>
          <emrClusterDefinitionName>string</emrClusterDefinitionName>
     </emrClusterDefinitionKey>
     <emrClusterDefinition>
          <sshKeyPairName>string</sshKeyPairName>
          <subnetId>string</subnetId>
          <logBucket>string</logBucket>
          <keepAlive>true</keepAlive>
          <visibleToAll>true</visibleToAll>
          <terminationProtection>true</terminationProtection>
          <encryptionEnabled>true</encryptionEnabled>
          <serviceIamRole>string</serviceIamRole>
          <ec2NodeIamProfileName>string</ec2NodeIamProfileName>
          <amiVersion>string</amiVersion>
          <releaseLabel>string</releaseLabel>
          <hadoopVersion>string</hadoopVersion>
          <hiveVersion>string</hiveVersion>
          <pigVersion>string</pigVersion>
          <installOozie>true</installOozie>
          <customBootstrapActionMaster>
               <scriptDefinition>
                    <scriptName>string</scriptName>
                    <scriptLocation>string</scriptLocation>
                    <scriptArguments>
                         <argument>string</argument>
                    </scriptArguments>
               </scriptDefinition>
          </customBootstrapActionMaster>
          <customBootstrapActionAll>
               <scriptDefinition>
                    <scriptName>string</scriptName>
                    <scriptLocation>string</scriptLocation>
                    <scriptArguments>
                         <argument>string</argument>
                    </scriptArguments>
               </scriptDefinition>
          </customBootstrapActionAll>
          <additionalInfo>string</additionalInfo>
          <instanceDefinitions>
               <masterInstances>
                    <instanceCount>0</instanceCount>
                    <instanceType>string</instanceType>
                    <instanceSpotPrice>0</instanceSpotPrice>
                    <instanceMaxSearchPrice>0</instanceMaxSearchPrice>
                    <instanceOnDemandThreshold>0</instanceOnDemandThreshold>
               </masterInstances>
               <coreInstances>
                    <instanceCount>0</instanceCount>
                    <instanceType>string</instanceType>
                    <instanceSpotPrice>0</instanceSpotPrice>
                    <instanceMaxSearchPrice>0</instanceMaxSearchPrice>
                    <instanceOnDemandThreshold>0</instanceOnDemandThreshold>
               </coreInstances>
               <taskInstances>
                    <instanceCount>0</instanceCount>
                    <instanceType>string</instanceType>
                    <instanceSpotPrice>0</instanceSpotPrice>
                    <instanceMaxSearchPrice>0</instanceMaxSearchPrice>
                    <instanceOnDemandThreshold>0</instanceOnDemandThreshold>
               </taskInstances>
          </instanceDefinitions>
          <nodeTags>
               <nodeTag>
                    <tagName>string</tagName>
                    <tagValue>string</tagValue>
               </nodeTag>
          </nodeTags>
          <supportedProduct>string</supportedProduct>
          <applications>
               <application>
                    <name>string</name>
                    <version>string</version>
                    <args>
                         <arg>string</arg>
                    </args>
                    <additionalInfoList>
                         <additionalInfo>
                              <name>string</name>
                              <value>string</value>
                         </additionalInfo>
                    </additionalInfoList>
               </application>
          </applications>
          <configurations>
               <configuration>
                    <classification>string</classification>
                    <configurations>
                         <configuration/>
                    </configurations>
                    <properties>
                         <property>
                              <name>string</name>
                              <value>string</value>
                         </property>
                    </properties>
               </configuration>
          </configurations>
          <daemonConfigurations>
               <daemonParam>
                    <name>string</name>
                    <value>string</value>
               </daemonParam>
          </daemonConfigurations>
          <hadoopConfigurations/>
          <hadoopJarSteps>
               <hadoopJarStep>
                    <stepName>string</stepName>
                    <jarLocation>string</jarLocation>
                    <mainClass>string</mainClass>
                    <scriptArguments>
                         <argument>string</argument>
                    </scriptArguments>
                    <continueOnError>true</continueOnError>
               </hadoopJarStep>
          </hadoopJarSteps>
          <additionalMasterSecurityGroups>
               <additionalMasterSecurityGroup>string</additionalMasterSecurityGroup>
          </additionalMasterSecurityGroups>
          <additionalSlaveSecurityGroups>
               <additionalSlaveSecurityGroup>string</additionalSlaveSecurityGroup>
          </additionalSlaveSecurityGroups>
     </emrClusterDefinition>
</emrClusterDefinitionInformation>

Response Content Type

Expected Partition Value

delete /expectedPartitionValues

deleteExpectedPartitionValues

Implementation Notes

Deletes specified expected partition values from an existing partition key group which is identified by name.

Parameter (body): the information needed to delete the expected partition values
Parameter content type: Model JSON Schema XML Example expectedPartitionValuesDeleteRequest { partitionKeyGroupKey (partitionKeyGroupKey): Value that uniquely identifies a Partition Key Group , expectedPartitionValues (Array[string], optional): List of Expected Partition Values } partitionKeyGroupKey { partitionKeyGroupName (string): The name of the Partition Key Group } `{ "partitionKeyGroupKey": { "partitionKeyGroupName": "string" }, "expectedPartitionValues": [ "string" ] }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <expectedPartitionValuesDeleteRequest> <partitionKeyGroupKey> <partitionKeyGroupName>string</partitionKeyGroupName> </partitionKeyGroupKey> <expectedPartitionValues> <expectedPartitionValue>string</expectedPartitionValue> </expectedPartitionValues> </expectedPartitionValuesDeleteRequest>` Click to set as parameter value

Response (Status 200)

expectedPartitionValuesInformation {

partitionKeyGroupKey (partitionKeyGroupKey):

Value that uniquely identifies a Partition Key Group

,

expectedPartitionValues (Array[string], optional):

List of Expected Partition Values

}
partitionKeyGroupKey {

partitionKeyGroupName (string):

The name of the Partition Key Group

}

{
  "partitionKeyGroupKey": {
    "partitionKeyGroupName": "string"
  },
  "expectedPartitionValues": [
    "string"
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<expectedPartitionValuesInformation>
     <partitionKeyGroupKey>
          <partitionKeyGroupName>string</partitionKeyGroupName>
     </partitionKeyGroupKey>
     <expectedPartitionValues>
          <expectedPartitionValue>string</expectedPartitionValue>
     </expectedPartitionValues>
</expectedPartitionValuesInformation>

Response Content Type

post /expectedPartitionValues

createExpectedPartitionValues

Implementation Notes

Creates a list of expected partition values for an existing partition key group.

Parameter (body): the information needed to create the expected partition values
Parameter content type: Model JSON Schema XML Example expectedPartitionValuesCreateRequest { partitionKeyGroupKey (partitionKeyGroupKey): Value that uniquely identifies a Partition Key Group , expectedPartitionValues (Array[string], optional): List of Expected Partition Values } partitionKeyGroupKey { partitionKeyGroupName (string): The name of the Partition Key Group } `{ "partitionKeyGroupKey": { "partitionKeyGroupName": "string" }, "expectedPartitionValues": [ "string" ] }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <expectedPartitionValuesCreateRequest> <partitionKeyGroupKey> <partitionKeyGroupName>string</partitionKeyGroupName> </partitionKeyGroupKey> <expectedPartitionValues> <expectedPartitionValue>string</expectedPartitionValue> </expectedPartitionValues> </expectedPartitionValuesCreateRequest>` Click to set as parameter value

Response (Status 200)

expectedPartitionValuesInformation {

partitionKeyGroupKey (partitionKeyGroupKey):

Value that uniquely identifies a Partition Key Group

,

expectedPartitionValues (Array[string], optional):

List of Expected Partition Values

}
partitionKeyGroupKey {

partitionKeyGroupName (string):

The name of the Partition Key Group

}

{
  "partitionKeyGroupKey": {
    "partitionKeyGroupName": "string"
  },
  "expectedPartitionValues": [
    "string"
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<expectedPartitionValuesInformation>
     <partitionKeyGroupKey>
          <partitionKeyGroupName>string</partitionKeyGroupName>
     </partitionKeyGroupKey>
     <expectedPartitionValues>
          <expectedPartitionValue>string</expectedPartitionValue>
     </expectedPartitionValues>
</expectedPartitionValuesInformation>

Response Content Type

get /expectedPartitionValues/partitionKeyGroups/{partitionKeyGroupName}

getExpectedPartitionValues

Implementation Notes

Retrieves a range of existing expected partition values.

Parameters

Parameter	Description	Parameter Type	Data Type
partitionKeyGroupName	the partition key group name	path	string
startExpectedPartitionValue	the start expected partition value for the expected partition value range	query	string
endExpectedPartitionValue	the end expected partition value for the expected partition value range	query	string

Response (Status 200)

expectedPartitionValuesInformation {

partitionKeyGroupKey (partitionKeyGroupKey):

Value that uniquely identifies a Partition Key Group

,

expectedPartitionValues (Array[string], optional):

List of Expected Partition Values

}
partitionKeyGroupKey {

partitionKeyGroupName (string):

The name of the Partition Key Group

}

{
  "partitionKeyGroupKey": {
    "partitionKeyGroupName": "string"
  },
  "expectedPartitionValues": [
    "string"
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<expectedPartitionValuesInformation>
     <partitionKeyGroupKey>
          <partitionKeyGroupName>string</partitionKeyGroupName>
     </partitionKeyGroupKey>
     <expectedPartitionValues>
          <expectedPartitionValue>string</expectedPartitionValue>
     </expectedPartitionValues>
</expectedPartitionValuesInformation>

Response Content Type

get /expectedPartitionValues/partitionKeyGroups/{partitionKeyGroupName}/expectedPartitionValues/{expectedPartitionValue}

getExpectedPartitionValue

File Type

Job

get /jobs

getJobs

Implementation Notes

Gets a list of job executions based on the specified filter parameters.

Jobs' namespace to which you do not have READ permissions to will be omitted from the result.

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	an optional namespace filter	query	string
jobName	an optional job name filter	query	string
status	an optional job status filter	query	string
startTime	an optional start time filter (ex. 2015, 2015-12, 2015-12-12T3:4:5)	query	string
endTime	an optional end time filter (ex. 2015, 2015-12, 2015-12-12T3:4:5)	query	string

Response (Status 200)

jobSummaries {

jobSummaries (Array[jobSummary], optional)

}
jobSummary {

id (string):

              The job id that uniquely identifies the previously submitted job

,

namespace (string, optional):

              The namespace of the job

,

jobName (string):

              The name of the job

,

startTime (string):

              The start time of the job

,

endTime (string, optional):

              The end time of the job. It is not returned for a job in RUNNING state

,

status (string, optional) = ['RUNNING', 'SUSPENDED', 'COMPLETED']

string
Enum:	"RUNNING", "SUSPENDED", "COMPLETED"

,

totalExceptions (integer, optional):

              The number of exceptions

}

{
  "jobSummaries": [
    {
      "id": "string",
      "namespace": "string",
      "jobName": "string",
      "startTime": "2017-04-29T14:40:27.033Z",
      "endTime": "2017-04-29T14:40:27.033Z",
      "status": "RUNNING",
      "totalExceptions": 0
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<jobSummaries>
     <jobSummary>
          <id>string</id>
          <namespace>string</namespace>
          <jobName>string</jobName>
          <startTime>2015-12-25T00:00:00.000-05:00</startTime>
          <endTime>2015-12-25T00:00:00.000-05:00</endTime>
          <status>RUNNING</status>
          <totalExceptions>0</totalExceptions>
     </jobSummary>
</jobSummaries>

Response Content Type

post /jobs

createJob

Implementation Notes

Creates and starts a new job asynchronously.

Requires EXECUTE permission on namespace

Parameter (body): the information needed to create the job.

Parameter content type:

jobCreateRequest {

namespace (string):

The namespace of the job

,

jobName (string):

The name of the job

,

parameters (Array[parameter], optional):

              List of key/value pairs that will be made available to the job when it is executed. These parameters will override any parameters defined as
              part of the job definition

,

s3PropertiesLocation (s3PropertiesLocation, optional):

The location to the Java properties file in S3

}
parameter {

name (string):

              Name of the parameter

,

value (string, optional):

              Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the
              application logs

}
s3PropertiesLocation {

bucketName (string):

              The S3 bucket name

,

key (string):

              The S3 object key

}

{
  "namespace": "string",
  "jobName": "string",
  "parameters": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "s3PropertiesLocation": {
    "bucketName": "string",
    "key": "string"
  }
}

Click to set as parameter value

<?xml version="1.0" encoding="UTF-8"?>
<jobCreateRequest>
     <namespace>string</namespace>
     <jobName>string</jobName>
     <parameters>
          <parameter>
               <name>string</name>
               <value>string</value>
          </parameter>
     </parameters>
     <s3PropertiesLocation>
          <bucketName>string</bucketName>
          <key>string</key>
     </s3PropertiesLocation>
</jobCreateRequest>

Click to set as parameter value

Response (Status 200)

job {

id (string):

              The internal identifier that uniquely references a job

,

status (string, optional) = ['RUNNING', 'SUSPENDED', 'COMPLETED']

string
Enum:	"RUNNING", "SUSPENDED", "COMPLETED"

,

namespace (string, optional):

The namespace of the job

,

jobName (string, optional):

The name of the job

,

startTime (string, optional):

              The start time of the job

,

endTime (string, optional):

              The end time of the job. It is not returned for a job in RUNNING state

,

currentWorkflowStep (workflowStep, optional):

              The step where the workflow currently is. It is returned for a job in RUNNING state

,

completedWorkflowSteps (Array[workflowStep], optional):

              The steps that have been completed. For a job in RUNNING state, steps up to the last Async task will be returned. For a job in
              COMPLETED state, all executed steps will be returned

,

parameters (Array[parameter], optional):

              Current workflow variables and values

,

activitiJobXml (string, optional):

              Activiti workflow XML related to the job

,

workflowErrors (Array[workflowError], optional):

              The workflow errors

,

deleteReason (string, optional):

              A reason this job has been deleted. It is returned if the job has been deleted

}
workflowStep {

id (string):

              The internal identifier that uniquely references a step

,

name (string, optional):

              The name of the step

,

startTime (string, optional):

              The start time of the step

,

endTime (string, optional):

              The end time of the step

}
parameter {

name (string):

              Name of the parameter

,

value (string, optional):

              Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the
              application logs

}
workflowError {

errorMessage (string):

              Error message

,

retriesLeft (integer, optional):

              Number of retries left

,

errorStackTrace (string, optional):

              The error stack trace

}

{
  "id": "string",
  "status": "RUNNING",
  "namespace": "string",
  "jobName": "string",
  "startTime": "2017-04-29T14:40:27.036Z",
  "endTime": "2017-04-29T14:40:27.036Z",
  "currentWorkflowStep": {
    "id": "string",
    "name": "string",
    "startTime": "2017-04-29T14:40:27.036Z",
    "endTime": "2017-04-29T14:40:27.036Z"
  },
  "completedWorkflowSteps": [
    {
      "id": "string",
      "name": "string",
      "startTime": "2017-04-29T14:40:27.036Z",
      "endTime": "2017-04-29T14:40:27.036Z"
    }
  ],
  "parameters": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "activitiJobXml": "string",
  "workflowErrors": [
    {
      "errorMessage": "string",
      "retriesLeft": 0,
      "errorStackTrace": "string"
    }
  ],
  "deleteReason": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<job>
     <id>string</id>
     <status>RUNNING</status>
     <namespace>string</namespace>
     <jobName>string</jobName>
     <startTime>2015-12-25T00:00:00.000-05:00</startTime>
     <endTime>2015-12-25T00:00:00.000-05:00</endTime>
     <currentWorkflowStep>
          <id>string</id>
          <name>string</name>
          <startTime>2015-12-25T00:00:00.000-05:00</startTime>
          <endTime>2015-12-25T00:00:00.000-05:00</endTime>
     </currentWorkflowStep>
     <completedWorkflowSteps>
          <workflowStep>
               <id>string</id>
               <name>string</name>
               <startTime>2015-12-25T00:00:00.000-05:00</startTime>
               <endTime>2015-12-25T00:00:00.000-05:00</endTime>
          </workflowStep>
     </completedWorkflowSteps>
     <parameters>
          <parameter>
               <name>string</name>
               <value>string</value>
          </parameter>
     </parameters>
     <activitiJobXml>
    <![CDATA[
    string]]>
  </activitiJobXml>
     <workflowErrors>
          <workflowError>
               <errorMessage>string</errorMessage>
               <retriesLeft>0</retriesLeft>
               <errorStackTrace>
        <![CDATA[
        string]]>
      </errorStackTrace>
          </workflowError>
     </workflowErrors>
     <deleteReason>string</deleteReason>
</job>

Response Content Type

delete /jobs/ids/{id}

deleteJob

Implementation Notes

Deletes a currently running job and preserves the job state in history.

Requires EXECUTE permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
id		The job id	path	string
jobDeleteRequest: The delete request	Parameter content type: Model JSON Schema XML Example jobDeleteRequest { deleteReason (string) } `{ "deleteReason": "string" }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <jobDeleteRequest> <deleteReason>string</deleteReason> </jobDeleteRequest>` Click to set as parameter value

Response (Status 200)

job {

id (string):

              The internal identifier that uniquely references a job

,

status (string, optional) = ['RUNNING', 'SUSPENDED', 'COMPLETED']

string
Enum:	"RUNNING", "SUSPENDED", "COMPLETED"

,

namespace (string, optional):

The namespace of the job

,

jobName (string, optional):

The name of the job

,

startTime (string, optional):

              The start time of the job

,

endTime (string, optional):

              The end time of the job. It is not returned for a job in RUNNING state

,

currentWorkflowStep (workflowStep, optional):

              The step where the workflow currently is. It is returned for a job in RUNNING state

,

completedWorkflowSteps (Array[workflowStep], optional):

              The steps that have been completed. For a job in RUNNING state, steps up to the last Async task will be returned. For a job in
              COMPLETED state, all executed steps will be returned

,

parameters (Array[parameter], optional):

              Current workflow variables and values

,

activitiJobXml (string, optional):

              Activiti workflow XML related to the job

,

workflowErrors (Array[workflowError], optional):

              The workflow errors

,

deleteReason (string, optional):

              A reason this job has been deleted. It is returned if the job has been deleted

}
workflowStep {

id (string):

              The internal identifier that uniquely references a step

,

name (string, optional):

              The name of the step

,

startTime (string, optional):

              The start time of the step

,

endTime (string, optional):

              The end time of the step

}
parameter {

name (string):

              Name of the parameter

,

value (string, optional):

              Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the
              application logs

}
workflowError {

errorMessage (string):

              Error message

,

retriesLeft (integer, optional):

              Number of retries left

,

errorStackTrace (string, optional):

              The error stack trace

}

{
  "id": "string",
  "status": "RUNNING",
  "namespace": "string",
  "jobName": "string",
  "startTime": "2017-04-29T14:40:27.039Z",
  "endTime": "2017-04-29T14:40:27.039Z",
  "currentWorkflowStep": {
    "id": "string",
    "name": "string",
    "startTime": "2017-04-29T14:40:27.039Z",
    "endTime": "2017-04-29T14:40:27.039Z"
  },
  "completedWorkflowSteps": [
    {
      "id": "string",
      "name": "string",
      "startTime": "2017-04-29T14:40:27.039Z",
      "endTime": "2017-04-29T14:40:27.039Z"
    }
  ],
  "parameters": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "activitiJobXml": "string",
  "workflowErrors": [
    {
      "errorMessage": "string",
      "retriesLeft": 0,
      "errorStackTrace": "string"
    }
  ],
  "deleteReason": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<job>
     <id>string</id>
     <status>RUNNING</status>
     <namespace>string</namespace>
     <jobName>string</jobName>
     <startTime>2015-12-25T00:00:00.000-05:00</startTime>
     <endTime>2015-12-25T00:00:00.000-05:00</endTime>
     <currentWorkflowStep>
          <id>string</id>
          <name>string</name>
          <startTime>2015-12-25T00:00:00.000-05:00</startTime>
          <endTime>2015-12-25T00:00:00.000-05:00</endTime>
     </currentWorkflowStep>
     <completedWorkflowSteps>
          <workflowStep>
               <id>string</id>
               <name>string</name>
               <startTime>2015-12-25T00:00:00.000-05:00</startTime>
               <endTime>2015-12-25T00:00:00.000-05:00</endTime>
          </workflowStep>
     </completedWorkflowSteps>
     <parameters>
          <parameter>
               <name>string</name>
               <value>string</value>
          </parameter>
     </parameters>
     <activitiJobXml>
    <![CDATA[
    string]]>
  </activitiJobXml>
     <workflowErrors>
          <workflowError>
               <errorMessage>string</errorMessage>
               <retriesLeft>0</retriesLeft>
               <errorStackTrace>
        <![CDATA[
        string]]>
      </errorStackTrace>
          </workflowError>
     </workflowErrors>
     <deleteReason>string</deleteReason>
</job>

Response Content Type

get /jobs/ids/{id}

getJob

Implementation Notes

Gets the details of a previously submitted job.

Requires READ permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
id		the job id.	path	string
verbose			query	boolean

Response (Status 200)

job {

id (string):

              The internal identifier that uniquely references a job

,

status (string, optional) = ['RUNNING', 'SUSPENDED', 'COMPLETED']

string
Enum:	"RUNNING", "SUSPENDED", "COMPLETED"

,

namespace (string, optional):

The namespace of the job

,

jobName (string, optional):

The name of the job

,

startTime (string, optional):

              The start time of the job

,

endTime (string, optional):

              The end time of the job. It is not returned for a job in RUNNING state

,

currentWorkflowStep (workflowStep, optional):

              The step where the workflow currently is. It is returned for a job in RUNNING state

,

completedWorkflowSteps (Array[workflowStep], optional):

              The steps that have been completed. For a job in RUNNING state, steps up to the last Async task will be returned. For a job in
              COMPLETED state, all executed steps will be returned

,

parameters (Array[parameter], optional):

              Current workflow variables and values

,

activitiJobXml (string, optional):

              Activiti workflow XML related to the job

,

workflowErrors (Array[workflowError], optional):

              The workflow errors

,

deleteReason (string, optional):

              A reason this job has been deleted. It is returned if the job has been deleted

}
workflowStep {

id (string):

              The internal identifier that uniquely references a step

,

name (string, optional):

              The name of the step

,

startTime (string, optional):

              The start time of the step

,

endTime (string, optional):

              The end time of the step

}
parameter {

name (string):

              Name of the parameter

,

value (string, optional):

              Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the
              application logs

}
workflowError {

errorMessage (string):

              Error message

,

retriesLeft (integer, optional):

              Number of retries left

,

errorStackTrace (string, optional):

              The error stack trace

}

{
  "id": "string",
  "status": "RUNNING",
  "namespace": "string",
  "jobName": "string",
  "startTime": "2017-04-29T14:40:27.042Z",
  "endTime": "2017-04-29T14:40:27.042Z",
  "currentWorkflowStep": {
    "id": "string",
    "name": "string",
    "startTime": "2017-04-29T14:40:27.042Z",
    "endTime": "2017-04-29T14:40:27.042Z"
  },
  "completedWorkflowSteps": [
    {
      "id": "string",
      "name": "string",
      "startTime": "2017-04-29T14:40:27.042Z",
      "endTime": "2017-04-29T14:40:27.042Z"
    }
  ],
  "parameters": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "activitiJobXml": "string",
  "workflowErrors": [
    {
      "errorMessage": "string",
      "retriesLeft": 0,
      "errorStackTrace": "string"
    }
  ],
  "deleteReason": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<job>
     <id>string</id>
     <status>RUNNING</status>
     <namespace>string</namespace>
     <jobName>string</jobName>
     <startTime>2015-12-25T00:00:00.000-05:00</startTime>
     <endTime>2015-12-25T00:00:00.000-05:00</endTime>
     <currentWorkflowStep>
          <id>string</id>
          <name>string</name>
          <startTime>2015-12-25T00:00:00.000-05:00</startTime>
          <endTime>2015-12-25T00:00:00.000-05:00</endTime>
     </currentWorkflowStep>
     <completedWorkflowSteps>
          <workflowStep>
               <id>string</id>
               <name>string</name>
               <startTime>2015-12-25T00:00:00.000-05:00</startTime>
               <endTime>2015-12-25T00:00:00.000-05:00</endTime>
          </workflowStep>
     </completedWorkflowSteps>
     <parameters>
          <parameter>
               <name>string</name>
               <value>string</value>
          </parameter>
     </parameters>
     <activitiJobXml>
    <![CDATA[
    string]]>
  </activitiJobXml>
     <workflowErrors>
          <workflowError>
               <errorMessage>string</errorMessage>
               <retriesLeft>0</retriesLeft>
               <errorStackTrace>
        <![CDATA[
        string]]>
      </errorStackTrace>
          </workflowError>
     </workflowErrors>
     <deleteReason>string</deleteReason>
</job>

Response Content Type

put /jobs/ids/{id}

updateJob

Implementation Notes

Activates or suspends a job execution.

Requires EXECUTE permission on namespace

Parameters

Parameter Value Description Parameter Type Data Type

id

the job id

path

string

jobUpdateRequest:

the job update request

Parameter content type:

jobUpdateRequest {

action (string) = ['SUSPEND', 'RESUME']

string
Enum:	"SUSPEND", "RESUME"

}

{
  "action": "SUSPEND"
}

Click to set as parameter value

<?xml version="1.0" encoding="UTF-8"?>
<jobUpdateRequest>
     <action>SUSPEND</action>
</jobUpdateRequest>

Click to set as parameter value

Response (Status 200)

job {

id (string):

              The internal identifier that uniquely references a job

,

status (string, optional) = ['RUNNING', 'SUSPENDED', 'COMPLETED']

string
Enum:	"RUNNING", "SUSPENDED", "COMPLETED"

,

namespace (string, optional):

The namespace of the job

,

jobName (string, optional):

The name of the job

,

startTime (string, optional):

              The start time of the job

,

endTime (string, optional):

              The end time of the job. It is not returned for a job in RUNNING state

,

currentWorkflowStep (workflowStep, optional):

              The step where the workflow currently is. It is returned for a job in RUNNING state

,

completedWorkflowSteps (Array[workflowStep], optional):

              The steps that have been completed. For a job in RUNNING state, steps up to the last Async task will be returned. For a job in
              COMPLETED state, all executed steps will be returned

,

parameters (Array[parameter], optional):

              Current workflow variables and values

,

activitiJobXml (string, optional):

              Activiti workflow XML related to the job

,

workflowErrors (Array[workflowError], optional):

              The workflow errors

,

deleteReason (string, optional):

              A reason this job has been deleted. It is returned if the job has been deleted

}
workflowStep {

id (string):

              The internal identifier that uniquely references a step

,

name (string, optional):

              The name of the step

,

startTime (string, optional):

              The start time of the step

,

endTime (string, optional):

              The end time of the step

}
parameter {

name (string):

              Name of the parameter

,

value (string, optional):

              Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the
              application logs

}
workflowError {

errorMessage (string):

              Error message

,

retriesLeft (integer, optional):

              Number of retries left

,

errorStackTrace (string, optional):

              The error stack trace

}

{
  "id": "string",
  "status": "RUNNING",
  "namespace": "string",
  "jobName": "string",
  "startTime": "2017-04-29T14:40:27.045Z",
  "endTime": "2017-04-29T14:40:27.045Z",
  "currentWorkflowStep": {
    "id": "string",
    "name": "string",
    "startTime": "2017-04-29T14:40:27.045Z",
    "endTime": "2017-04-29T14:40:27.045Z"
  },
  "completedWorkflowSteps": [
    {
      "id": "string",
      "name": "string",
      "startTime": "2017-04-29T14:40:27.045Z",
      "endTime": "2017-04-29T14:40:27.045Z"
    }
  ],
  "parameters": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "activitiJobXml": "string",
  "workflowErrors": [
    {
      "errorMessage": "string",
      "retriesLeft": 0,
      "errorStackTrace": "string"
    }
  ],
  "deleteReason": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<job>
     <id>string</id>
     <status>RUNNING</status>
     <namespace>string</namespace>
     <jobName>string</jobName>
     <startTime>2015-12-25T00:00:00.000-05:00</startTime>
     <endTime>2015-12-25T00:00:00.000-05:00</endTime>
     <currentWorkflowStep>
          <id>string</id>
          <name>string</name>
          <startTime>2015-12-25T00:00:00.000-05:00</startTime>
          <endTime>2015-12-25T00:00:00.000-05:00</endTime>
     </currentWorkflowStep>
     <completedWorkflowSteps>
          <workflowStep>
               <id>string</id>
               <name>string</name>
               <startTime>2015-12-25T00:00:00.000-05:00</startTime>
               <endTime>2015-12-25T00:00:00.000-05:00</endTime>
          </workflowStep>
     </completedWorkflowSteps>
     <parameters>
          <parameter>
               <name>string</name>
               <value>string</value>
          </parameter>
     </parameters>
     <activitiJobXml>
    <![CDATA[
    string]]>
  </activitiJobXml>
     <workflowErrors>
          <workflowError>
               <errorMessage>string</errorMessage>
               <retriesLeft>0</retriesLeft>
               <errorStackTrace>
        <![CDATA[
        string]]>
      </errorStackTrace>
          </workflowError>
     </workflowErrors>
     <deleteReason>string</deleteReason>
</job>

Response Content Type

post /jobs/signal

signalJob

Implementation Notes

Signals the job with the receive task.

Requires EXECUTE permission on namespace

Parameter (body): the information needed to signal the job.

Parameter content type:

jobSignalRequest {

id (string):

              The job id that uniquely identifies the previously submitted job

,

receiveTaskId (string):

              The task Id of the receive task in the job workflow to signal. The job must be waiting on this task at the time of this call

,

parameters (Array[parameter], optional):

              List of key/value pairs that will be made available to the job

,

s3PropertiesLocation (s3PropertiesLocation, optional):

              The location to the Java properties file in S3

}
parameter {

name (string):

              Name of the parameter

,

value (string, optional):

              Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the
              application logs

}
s3PropertiesLocation {

bucketName (string):

              The S3 bucket name

,

key (string):

              The S3 object key

}

{
  "id": "string",
  "receiveTaskId": "string",
  "parameters": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "s3PropertiesLocation": {
    "bucketName": "string",
    "key": "string"
  }
}

Click to set as parameter value

<?xml version="1.0" encoding="UTF-8"?>
<jobSignalRequest>
     <id>string</id>
     <receiveTaskId>string</receiveTaskId>
     <parameters>
          <parameter>
               <name>string</name>
               <value>string</value>
          </parameter>
     </parameters>
     <s3PropertiesLocation>
          <bucketName>string</bucketName>
          <key>string</key>
     </s3PropertiesLocation>
</jobSignalRequest>

Click to set as parameter value

Response (Status 200)

job {

id (string):

              The internal identifier that uniquely references a job

,

status (string, optional) = ['RUNNING', 'SUSPENDED', 'COMPLETED']

string
Enum:	"RUNNING", "SUSPENDED", "COMPLETED"

,

namespace (string, optional):

The namespace of the job

,

jobName (string, optional):

The name of the job

,

startTime (string, optional):

              The start time of the job

,

endTime (string, optional):

              The end time of the job. It is not returned for a job in RUNNING state

,

currentWorkflowStep (workflowStep, optional):

              The step where the workflow currently is. It is returned for a job in RUNNING state

,

completedWorkflowSteps (Array[workflowStep], optional):

              The steps that have been completed. For a job in RUNNING state, steps up to the last Async task will be returned. For a job in
              COMPLETED state, all executed steps will be returned

,

parameters (Array[parameter], optional):

              Current workflow variables and values

,

activitiJobXml (string, optional):

              Activiti workflow XML related to the job

,

workflowErrors (Array[workflowError], optional):

              The workflow errors

,

deleteReason (string, optional):

              A reason this job has been deleted. It is returned if the job has been deleted

}
workflowStep {

id (string):

              The internal identifier that uniquely references a step

,

name (string, optional):

              The name of the step

,

startTime (string, optional):

              The start time of the step

,

endTime (string, optional):

              The end time of the step

}
parameter {

name (string):

              Name of the parameter

,

value (string, optional):

              Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the
              application logs

}
workflowError {

errorMessage (string):

              Error message

,

retriesLeft (integer, optional):

              Number of retries left

,

errorStackTrace (string, optional):

              The error stack trace

}

{
  "id": "string",
  "status": "RUNNING",
  "namespace": "string",
  "jobName": "string",
  "startTime": "2017-04-29T14:40:27.048Z",
  "endTime": "2017-04-29T14:40:27.048Z",
  "currentWorkflowStep": {
    "id": "string",
    "name": "string",
    "startTime": "2017-04-29T14:40:27.048Z",
    "endTime": "2017-04-29T14:40:27.048Z"
  },
  "completedWorkflowSteps": [
    {
      "id": "string",
      "name": "string",
      "startTime": "2017-04-29T14:40:27.048Z",
      "endTime": "2017-04-29T14:40:27.048Z"
    }
  ],
  "parameters": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "activitiJobXml": "string",
  "workflowErrors": [
    {
      "errorMessage": "string",
      "retriesLeft": 0,
      "errorStackTrace": "string"
    }
  ],
  "deleteReason": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<job>
     <id>string</id>
     <status>RUNNING</status>
     <namespace>string</namespace>
     <jobName>string</jobName>
     <startTime>2015-12-25T00:00:00.000-05:00</startTime>
     <endTime>2015-12-25T00:00:00.000-05:00</endTime>
     <currentWorkflowStep>
          <id>string</id>
          <name>string</name>
          <startTime>2015-12-25T00:00:00.000-05:00</startTime>
          <endTime>2015-12-25T00:00:00.000-05:00</endTime>
     </currentWorkflowStep>
     <completedWorkflowSteps>
          <workflowStep>
               <id>string</id>
               <name>string</name>
               <startTime>2015-12-25T00:00:00.000-05:00</startTime>
               <endTime>2015-12-25T00:00:00.000-05:00</endTime>
          </workflowStep>
     </completedWorkflowSteps>
     <parameters>
          <parameter>
               <name>string</name>
               <value>string</value>
          </parameter>
     </parameters>
     <activitiJobXml>
    <![CDATA[
    string]]>
  </activitiJobXml>
     <workflowErrors>
          <workflowError>
               <errorMessage>string</errorMessage>
               <retriesLeft>0</retriesLeft>
               <errorStackTrace>
        <![CDATA[
        string]]>
      </errorStackTrace>
          </workflowError>
     </workflowErrors>
     <deleteReason>string</deleteReason>
</job>

Response Content Type

Job Definition

post /jobDefinitions

createJobDefinition

Implementation Notes

Creates a new job definition.

Requires WRITE permission on namespace

Parameter (body): the information needed to create the job definition.

Parameter content type:

jobDefinitionCreateRequest {

namespace (string):

              The name of a valid namespace known by the system

,

jobName (string):

              The name of the job definition

,

description (string, optional):

              An optional description of the job definition

,

activitiJobXml (string):

              Activiti workflow XML related to the job. Id should be named as "{applicationName}.{jobName}". Activiti XML can not contain a CDATA section

,

parameters (Array[parameter], optional):

              Default list of key/value pairs that will be made available to the job when it is executed. These values can be overridden by parameters
              specified during the job execution

,

s3PropertiesLocation (s3PropertiesLocation, optional):

              The location to the Java properties file in S3

}
parameter {

name (string):

              Name of the parameter

,

value (string, optional):

              Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the
              application logs

}
s3PropertiesLocation {

bucketName (string):

              The S3 bucket name

,

key (string):

              The S3 object key

}

{
  "namespace": "string",
  "jobName": "string",
  "description": "string",
  "activitiJobXml": "string",
  "parameters": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "s3PropertiesLocation": {
    "bucketName": "string",
    "key": "string"
  }
}

Click to set as parameter value

<?xml version="1.0" encoding="UTF-8"?>
<jobDefinitionCreateRequest>
     <namespace>string</namespace>
     <jobName>string</jobName>
     <description>string</description>
     <activitiJobXml>
    <![CDATA[
    string]]>
  </activitiJobXml>
     <parameters>
          <parameter>
               <name>string</name>
               <value>string</value>
          </parameter>
     </parameters>
     <s3PropertiesLocation>
          <bucketName>string</bucketName>
          <key>string</key>
     </s3PropertiesLocation>
</jobDefinitionCreateRequest>

Click to set as parameter value

Response (Status 200)

jobDefinition {

id (integer, optional):

              The internal identifier that uniquely references a job definition

,

namespace (string):

              The namespace of the job definition

,

jobName (string):

              The name of the job definition

,

description (string, optional):

              Description of the job definition

,

activitiJobXml (string):

              Activiti workflow XML related to the job

,

parameters (Array[parameter], optional):

              Default list of key/value pairs that will be made available to the job when it is executed. These values can be overridden by parameters
              specified during the job execution

,

s3PropertiesLocation (s3PropertiesLocation, optional):

              The location to the Java properties file in S3

,

lastUpdatedByUserId (string, optional):

The user ID under whose authorization context the workflow runs

}
parameter {

name (string):

              Name of the parameter

,

value (string, optional):

              Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the
              application logs

}
s3PropertiesLocation {

bucketName (string):

              The S3 bucket name

,

key (string):

              The S3 object key

}

{
  "id": 0,
  "namespace": "string",
  "jobName": "string",
  "description": "string",
  "activitiJobXml": "string",
  "parameters": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "s3PropertiesLocation": {
    "bucketName": "string",
    "key": "string"
  },
  "lastUpdatedByUserId": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<jobDefinition>
     <id>0</id>
     <namespace>string</namespace>
     <jobName>string</jobName>
     <description>string</description>
     <activitiJobXml>
    <![CDATA[
    string]]>
  </activitiJobXml>
     <parameters>
          <parameter>
               <name>string</name>
               <value>string</value>
          </parameter>
     </parameters>
     <s3PropertiesLocation>
          <bucketName>string</bucketName>
          <key>string</key>
     </s3PropertiesLocation>
     <lastUpdatedByUserId>string</lastUpdatedByUserId>
</jobDefinition>

Response Content Type

get /jobDefinitions/namespaces/{namespace}/jobNames/{jobName}

getJobDefinition

Implementation Notes

Gets an existing job definition.

Requires READ permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace of the job definition.	path	string
jobName		the job name of the job definition.	path	string

Response (Status 200)

jobDefinition {

id (integer, optional):

              The internal identifier that uniquely references a job definition

,

namespace (string):

              The namespace of the job definition

,

jobName (string):

              The name of the job definition

,

description (string, optional):

              Description of the job definition

,

activitiJobXml (string):

              Activiti workflow XML related to the job

,

parameters (Array[parameter], optional):

              Default list of key/value pairs that will be made available to the job when it is executed. These values can be overridden by parameters
              specified during the job execution

,

s3PropertiesLocation (s3PropertiesLocation, optional):

              The location to the Java properties file in S3

,

lastUpdatedByUserId (string, optional):

The user ID under whose authorization context the workflow runs

}
parameter {

name (string):

              Name of the parameter

,

value (string, optional):

              Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the
              application logs

}
s3PropertiesLocation {

bucketName (string):

              The S3 bucket name

,

key (string):

              The S3 object key

}

{
  "id": 0,
  "namespace": "string",
  "jobName": "string",
  "description": "string",
  "activitiJobXml": "string",
  "parameters": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "s3PropertiesLocation": {
    "bucketName": "string",
    "key": "string"
  },
  "lastUpdatedByUserId": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<jobDefinition>
     <id>0</id>
     <namespace>string</namespace>
     <jobName>string</jobName>
     <description>string</description>
     <activitiJobXml>
    <![CDATA[
    string]]>
  </activitiJobXml>
     <parameters>
          <parameter>
               <name>string</name>
               <value>string</value>
          </parameter>
     </parameters>
     <s3PropertiesLocation>
          <bucketName>string</bucketName>
          <key>string</key>
     </s3PropertiesLocation>
     <lastUpdatedByUserId>string</lastUpdatedByUserId>
</jobDefinition>

Response Content Type

put /jobDefinitions/namespaces/{namespace}/jobNames/{jobName}

updateJobDefinition

Implementation Notes

Updates an existing job definition.

Requires WRITE permission on namespace

Parameters

Parameter Value Description Parameter Type Data Type

namespace

the namespace of the job definition.

path

string

jobName

the job name of the job definition.

path

string

jobDefinitionUpdateRequest:

the information needed to update the job definition.

Parameter content type:

jobDefinitionUpdateRequest {

description (string, optional):

              An optional description of the job definition

,

activitiJobXml (string):

              Activiti workflow XML related to the job. Id should be named as "{applicationName}.{jobName}". Activiti XML can not contain a CDATA section

,

parameters (Array[parameter], optional):

              Default list of key/value pairs that will be made available to the job when it is executed. These values can be overridden by parameters
              specified during the job execution

,

s3PropertiesLocation (s3PropertiesLocation, optional):

              The location to the Java properties file in S3

}
parameter {

name (string):

              Name of the parameter

,

value (string, optional):

              Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the
              application logs

}
s3PropertiesLocation {

bucketName (string):

              The S3 bucket name

,

key (string):

              The S3 object key

}

{
  "description": "string",
  "activitiJobXml": "string",
  "parameters": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "s3PropertiesLocation": {
    "bucketName": "string",
    "key": "string"
  }
}

Click to set as parameter value

<?xml version="1.0" encoding="UTF-8"?>
<jobDefinitionUpdateRequest>
     <description>string</description>
     <activitiJobXml>
    <![CDATA[
    string]]>
  </activitiJobXml>
     <parameters>
          <parameter>
               <name>string</name>
               <value>string</value>
          </parameter>
     </parameters>
     <s3PropertiesLocation>
          <bucketName>string</bucketName>
          <key>string</key>
     </s3PropertiesLocation>
</jobDefinitionUpdateRequest>

Click to set as parameter value

Response (Status 200)

jobDefinition {

id (integer, optional):

              The internal identifier that uniquely references a job definition

,

namespace (string):

              The namespace of the job definition

,

jobName (string):

              The name of the job definition

,

description (string, optional):

              Description of the job definition

,

activitiJobXml (string):

              Activiti workflow XML related to the job

,

parameters (Array[parameter], optional):

              Default list of key/value pairs that will be made available to the job when it is executed. These values can be overridden by parameters
              specified during the job execution

,

s3PropertiesLocation (s3PropertiesLocation, optional):

              The location to the Java properties file in S3

,

lastUpdatedByUserId (string, optional):

The user ID under whose authorization context the workflow runs

}
parameter {

name (string):

              Name of the parameter

,

value (string, optional):

              Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the
              application logs

}
s3PropertiesLocation {

bucketName (string):

              The S3 bucket name

,

key (string):

              The S3 object key

}

{
  "id": 0,
  "namespace": "string",
  "jobName": "string",
  "description": "string",
  "activitiJobXml": "string",
  "parameters": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "s3PropertiesLocation": {
    "bucketName": "string",
    "key": "string"
  },
  "lastUpdatedByUserId": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<jobDefinition>
     <id>0</id>
     <namespace>string</namespace>
     <jobName>string</jobName>
     <description>string</description>
     <activitiJobXml>
    <![CDATA[
    string]]>
  </activitiJobXml>
     <parameters>
          <parameter>
               <name>string</name>
               <value>string</value>
          </parameter>
     </parameters>
     <s3PropertiesLocation>
          <bucketName>string</bucketName>
          <key>string</key>
     </s3PropertiesLocation>
     <lastUpdatedByUserId>string</lastUpdatedByUserId>
</jobDefinition>

Response Content Type

Namespace

- get /namespaces
  - getNamespaces
  Implementation Notes
  
  Gets a list of namespace keys for all namespaces defined in the system.
  Response (Status 200)
  Model
  
  JSON Schema
  
  XML Example
  
  namespaceKeys {
  namespaceKeys (Array[namespaceKey], optional)
  }
  namespaceKey {
  namespaceCode (string):
  The Namespace code
  
  }
  
  { "namespaceKeys": [ { "namespaceCode": "string" } ] }
  
  <?xml version="1.0" encoding="UTF-8"?> <namespaceKeys> <namespaceKey> <namespaceCode>string</namespaceCode> </namespaceKey> </namespaceKeys>
  Response Content Type
  
  Hide Response
  Curl
  
  Request URL
  
  Response Body
  
  Response Code

post /namespaces

createNamespace

delete /namespaces/{namespaceCode}

deleteNamespace

get /namespaces/{namespaceCode}

getNamespace

Namespace IAM Role Authorization

get /namespaceIamRoleAuthorizations

getNamespaceIamRoleAuthorizations

post /namespaceIamRoleAuthorizations

createNamespaceIamRoleAuthorization

Implementation Notes

Authorizes a namespace to use IAM roles.

Parameter (body): The namespace IAM role create request
Parameter content type: Model JSON Schema XML Example namespaceIamRoleAuthorizationCreateRequest { namespace (string, optional): The namespace to give authorizations to , iamRoles (Array[iamRole], optional): The list of IAM roles to authorize } iamRole { iamRoleName (string, optional): The name of the IAM role , iamRoleDescription (string, optional): A description of the IAM role } `{ "namespace": "string", "iamRoles": [ { "iamRoleName": "string", "iamRoleDescription": "string" } ] }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <namespaceIamRoleAuthorizationCreateRequest> <namespace>string</namespace> <iamRoles> <iamRole> <iamRoleName>string</iamRoleName> <iamRoleDescription>string</iamRoleDescription> </iamRole> </iamRoles> </namespaceIamRoleAuthorizationCreateRequest>` Click to set as parameter value

Response (Status 200)

namespaceIamRoleAuthorization {

namespace (string, optional):

The namespace

,

iamRoles (Array[iamRole], optional):

The list of IAM roles the namespace is authorized to use

}
iamRole {

iamRoleName (string, optional):

The name of the IAM role

,

iamRoleDescription (string, optional):

A description of the IAM role

}

{
  "namespace": "string",
  "iamRoles": [
    {
      "iamRoleName": "string",
      "iamRoleDescription": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<namespaceIamRoleAuthorization>
     <namespace>string</namespace>
     <iamRoles>
          <iamRole>
               <iamRoleName>string</iamRoleName>
               <iamRoleDescription>string</iamRoleDescription>
          </iamRole>
     </iamRoles>
</namespaceIamRoleAuthorization>

Response Content Type

delete /namespaceIamRoleAuthorizations/namespaces/{namespace}

deleteNamespaceIamRoleAuthorization

get /namespaceIamRoleAuthorizations/namespaces/{namespace}

getNamespaceIamRoleAuthorization

put /namespaceIamRoleAuthorizations/namespaces/{namespace}

updateNamespaceIamRoleAuthorization

Implementation Notes

Sets the authorizations a namespace has to use IAM roles.

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		The namespace to update authorizations	path	string
namespaceIamRoleAuthorizationUpdateRequest: The namespace IAM role update request	Parameter content type: Model JSON Schema XML Example namespaceIamRoleAuthorizationUpdateRequest { iamRoles (Array[iamRole], optional): The list of IAM roles to authorize } iamRole { iamRoleName (string, optional): The name of the IAM role , iamRoleDescription (string, optional): A description of the IAM role } `{ "iamRoles": [ { "iamRoleName": "string", "iamRoleDescription": "string" } ] }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <namespaceIamRoleAuthorizationUpdateRequest> <iamRoles> <iamRole> <iamRoleName>string</iamRoleName> <iamRoleDescription>string</iamRoleDescription> </iamRole> </iamRoles> </namespaceIamRoleAuthorizationUpdateRequest>` Click to set as parameter value

Response (Status 200)

namespaceIamRoleAuthorization {

namespace (string, optional):

The namespace

,

iamRoles (Array[iamRole], optional):

The list of IAM roles the namespace is authorized to use

}
iamRole {

iamRoleName (string, optional):

The name of the IAM role

,

iamRoleDescription (string, optional):

A description of the IAM role

}

{
  "namespace": "string",
  "iamRoles": [
    {
      "iamRoleName": "string",
      "iamRoleDescription": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<namespaceIamRoleAuthorization>
     <namespace>string</namespace>
     <iamRoles>
          <iamRole>
               <iamRoleName>string</iamRoleName>
               <iamRoleDescription>string</iamRoleDescription>
          </iamRole>
     </iamRoles>
</namespaceIamRoleAuthorization>

Response Content Type

Notification Registration Status

put /notificationRegistrationStatus/namespaces/{namespace}/notificationNames/{notificationName}

updateNotificationRegistrationStatus

Implementation Notes

Updates the status of a notification registration.

Requires WRITE permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		The namespace of the notification registration.	path	string
notificationName		The name of the notification registration.	path	string
notificationRegistrationStatusUpdateRequest: The request to update the status.	Parameter content type: Model JSON Schema XML Example notificationRegistrationStatusUpdateRequest { notificationRegistrationStatus (string): The status of the notification registration } `{ "notificationRegistrationStatus": "string" }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <notificationRegistrationStatusUpdateRequest> <notificationRegistrationStatus>string</notificationRegistrationStatus> </notificationRegistrationStatusUpdateRequest>` Click to set as parameter value

Response (Status 200)

notificationRegistrationStatusUpdateResponse {

notificationRegistrationKey (notificationRegistrationKey):

A unique identifier for a notification registration

,

notificationRegistrationStatus (string):

The status of the notification registration

}
notificationRegistrationKey {

namespace (string),

notificationName (string)

}

{
  "notificationRegistrationKey": {
    "namespace": "string",
    "notificationName": "string"
  },
  "notificationRegistrationStatus": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<notificationRegistrationStatusUpdateResponse>
     <notificationRegistrationKey>
          <namespace>string</namespace>
          <notificationName>string</notificationName>
     </notificationRegistrationKey>
     <notificationRegistrationStatus>string</notificationRegistrationStatus>
</notificationRegistrationStatusUpdateResponse>

Response Content Type

Partition Key Group

- get /partitionKeyGroups
  - getPartitionKeyGroups
  Implementation Notes
  
  Gets a list of all existing partition key groups.
  Response (Status 200)
  Model
  
  JSON Schema
  
  XML Example
  
  partitionKeyGroupKeys {
  partitionKeyGroupKeys (Array[partitionKeyGroupKey], optional)
  }
  partitionKeyGroupKey {
  partitionKeyGroupName (string):
  The name of the Partition Key Group
  
  }
  
  { "partitionKeyGroupKeys": [ { "partitionKeyGroupName": "string" } ] }
  
  <?xml version="1.0" encoding="UTF-8"?> <partitionKeyGroupKeys> <partitionKeyGroupKey> <partitionKeyGroupName>string</partitionKeyGroupName> </partitionKeyGroupKey> </partitionKeyGroupKeys>
  Response Content Type
  
  Hide Response
  Curl
  
  Request URL
  
  Response Body
  
  Response Code

post /partitionKeyGroups

createPartitionKeyGroup

Implementation Notes

Creates a new partition key group.

Parameter (body): the information needed to create a partition key group
Parameter content type: Model JSON Schema XML Example partitionKeyGroupCreateRequest { partitionKeyGroupKey (partitionKeyGroupKey): Value that uniquely identifies a Partition Key Group } partitionKeyGroupKey { partitionKeyGroupName (string): The name of the Partition Key Group } `{ "partitionKeyGroupKey": { "partitionKeyGroupName": "string" } }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <partitionKeyGroupCreateRequest> <partitionKeyGroupKey> <partitionKeyGroupName>string</partitionKeyGroupName> </partitionKeyGroupKey> </partitionKeyGroupCreateRequest>` Click to set as parameter value

Response (Status 200)

partitionKeyGroup {

partitionKeyGroupKey (partitionKeyGroupKey):

Value that uniquely identifies a Partition Key Group

}
partitionKeyGroupKey {

partitionKeyGroupName (string):

The name of the Partition Key Group

}

{
  "partitionKeyGroupKey": {
    "partitionKeyGroupName": "string"
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<partitionKeyGroup>
     <partitionKeyGroupKey>
          <partitionKeyGroupName>string</partitionKeyGroupName>
     </partitionKeyGroupKey>
</partitionKeyGroup>

Response Content Type

delete /partitionKeyGroups/{partitionKeyGroupName}

deletePartitionKeyGroup

get /partitionKeyGroups/{partitionKeyGroupName}

getPartitionKeyGroup

Storage

- get /storages
  - getStorages
  Implementation Notes
  
  Gets a list of namespace keys for all namespaces defined in the system.
  Response (Status 200)
  Model
  
  JSON Schema
  
  XML Example
  
  storageKeys {
  storageKeys (Array[storageKey], optional)
  }
  storageKey {
  storageName (string):
  Name of Storage
  
  }
  
  { "storageKeys": [ { "storageName": "string" } ] }
  
  <?xml version="1.0" encoding="UTF-8"?> <storageKeys> <storageKey> <storageName>string</storageName> </storageKey> </storageKeys>
  Response Content Type
  
  Hide Response
  Curl
  
  Request URL
  
  Response Body
  
  Response Code

post /storages

createStorage

Implementation Notes

Creates a new storage.

Parameter (body): the information needed to create the storage
Parameter content type: Model JSON Schema XML Example storageCreateRequest { name (string): Name of Storage , storagePlatformName (string): Name of Storage Platform (eg S3) associated with this Storage , attributes (Array[attribute], optional): Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage } attribute { name (string): Attribute key , value (string, optional): Attribute value } `{ "name": "string", "storagePlatformName": "string", "attributes": [ { "name": "string", "value": "string" } ] }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <storageCreateRequest> <name>string</name> <storagePlatformName>string</storagePlatformName> <attributes> <attribute> <name>string</name> <value>string</value> </attribute> </attributes> </storageCreateRequest>` Click to set as parameter value

Response (Status 200)

storage {

name (string):

Name of Storage

,

storagePlatformName (string):

Name of Storage Platform (eg S3) associated with this Storage

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}

{
  "name": "string",
  "storagePlatformName": "string",
  "attributes": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<storage>
     <name>string</name>
     <storagePlatformName>string</storagePlatformName>
     <attributes>
          <attribute>
               <name>string</name>
               <value>string</value>
          </attribute>
     </attributes>
</storage>

Response Content Type

delete /storages/{storageName}

deleteStorage

get /storages/{storageName}

getStorage

put /storages/{storageName}

updateStorage

Implementation Notes

Updates an existing storage.

Parameters

Parameter	Value	Description	Parameter Type	Data Type
storageName		the name of the storage to update	path	string
storageUpdateRequest: the information needed to update the storage	Parameter content type: Model JSON Schema XML Example storageUpdateRequest { noData (string, optional): There is nothing that is currently updated, but we will have something in the future } `{ "noData": "string" }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <storageUpdateRequest> <noData>string</noData> </storageUpdateRequest>` Click to set as parameter value

Response (Status 200)

storage {

name (string):

Name of Storage

,

storagePlatformName (string):

Name of Storage Platform (eg S3) associated with this Storage

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}

{
  "name": "string",
  "storagePlatformName": "string",
  "attributes": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<storage>
     <name>string</name>
     <storagePlatformName>string</storagePlatformName>
     <attributes>
          <attribute>
               <name>string</name>
               <value>string</value>
          </attribute>
     </attributes>
</storage>

Response Content Type

Storage Platform

- get /storagePlatforms
  - getStoragePlatforms
  Implementation Notes
  
  Gets a list of existing storage platforms.
  Response (Status 200)
  Model
  
  JSON Schema
  
  XML Example
  
  storagePlatforms {
  storagePlatforms (Array[storagePlatform], optional)
  }
  storagePlatform {
  name (string):
  Name of Storage Platform
  
  }
  
  { "storagePlatforms": [ "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<storagePlatform>\n <name>string</name>\n</storagePlatform>\n" ] }
  
  <?xml version="1.0" encoding="UTF-8"?> <storagePlatforms> <storagePlatform> <name>string</name> </storagePlatform> </storagePlatforms>
  Response Content Type
  
  Hide Response
  Curl
  
  Request URL
  
  Response Body
  
  Response Code

get /storagePlatforms/{name}

getStoragePlatform

Storage Policy

post /storagePolicies

createStoragePolicy

Implementation Notes

Creates a new storage policy.

Requires WRITE permission on namespace and READ permission on filter namespace

Parameter (body): the information needed to create the storage policy
Parameter content type: Model JSON Schema XML Example storagePolicyCreateRequest { storagePolicyKey (storagePolicyKey): Wrapper for the storage policy unique identifiers , storagePolicyRule (storagePolicyRule): Wrapper for the storage policy rule , storagePolicyFilter (storagePolicyFilter): The storage policy filter to be used to select business object data , storagePolicyTransition (storagePolicyTransition): The storage policy transition , status (string): The status of the storage policy. Supported values are: ENABLED, DISABLED } storagePolicyKey { namespace (string): The namespace of the storage policy , storagePolicyName (string): The name of the storage policy } storagePolicyRule { ruleType (string): The storage policy rule type. Supported rule types are: DAYS_SINCE_BDATA_REGISTERED , ruleValue (integer, optional): The storage policy rule value. This parameter is required } storagePolicyFilter { namespace (string, optional): The namespace of the registered business object definition. It is required when businessObjectDefinitionName is present , businessObjectDefinitionName (string, optional): The name of the registered business object definition. It is required when namespace is present , businessObjectFormatUsage (string, optional): The business object format usage. The usage does not need to exist in the system. It is required when businessObjectFormatFileType is present , businessObjectFormatFileType (string, optional): The business object format file type. The file type must be known by the system. It is required when businessObjectFormatUsage is present , storageName (string): The name of the storage that this storage policy applies to. The storage with this name must already exist. Currently, only S3 storage platform type is supported by the storage policies } storagePolicyTransition { destinationStorageName (string): The name of the destination storage. The storage with this name must already exist. Currently, only GLACIER storage platform type is supported for the destination storage by the storage policies } `{ "storagePolicyKey": { "namespace": "string", "storagePolicyName": "string" }, "storagePolicyRule": { "ruleType": "string", "ruleValue": 0 }, "storagePolicyFilter": { "namespace": "string", "businessObjectDefinitionName": "string", "businessObjectFormatUsage": "string", "businessObjectFormatFileType": "string", "storageName": "string" }, "storagePolicyTransition": { "destinationStorageName": "string" }, "status": "string" }` Click to set as parameter value <?xml version="1.0" encoding="UTF-8"?> <storagePolicyCreateRequest> <storagePolicyKey> <namespace>string</namespace> <storagePolicyName>string</storagePolicyName> </storagePolicyKey> <storagePolicyRule> <ruleType>string</ruleType> <ruleValue>0</ruleValue> </storagePolicyRule> <storagePolicyFilter> <namespace>string</namespace> <businessObjectDefinitionName>string</businessObjectDefinitionName> <businessObjectFormatUsage>string</businessObjectFormatUsage> <businessObjectFormatFileType>string</businessObjectFormatFileType> <storageName>string</storageName> </storagePolicyFilter> <storagePolicyTransition> <destinationStorageName>string</destinationStorageName> </storagePolicyTransition> <status>string</status> </storagePolicyCreateRequest> Click to set as parameter value

Response (Status 200)

storagePolicy {

id (integer, optional):

A system unique ID of this storage policy

,

storagePolicyKey (storagePolicyKey):

Wrapper for the storage policy unique identifiers

,

storagePolicyRule (storagePolicyRule):

Wrapper for the storage policy rule

,

storagePolicyFilter (storagePolicyFilter):

The storage policy filter to be used to select business object data

,

storagePolicyTransition (storagePolicyTransition):

The storage policy transition

,

status (string):

The status of the storage policy

}
storagePolicyKey {

namespace (string):

The namespace of the storage policy

,

storagePolicyName (string):

The name of the storage policy

}
storagePolicyRule {

ruleType (string):

The storage policy rule type. Supported rule types are: DAYS_SINCE_BDATA_REGISTERED

,

ruleValue (integer, optional):

The storage policy rule value. This parameter is required

}
storagePolicyFilter {

namespace (string, optional):

The namespace of the registered business object definition. It is required when businessObjectDefinitionName is present

,

businessObjectDefinitionName (string, optional):

The name of the registered business object definition. It is required when namespace is present

,

businessObjectFormatUsage (string, optional):

The business object format usage. The usage does not need to exist in the system. It is required when businessObjectFormatFileType is present

,

businessObjectFormatFileType (string, optional):

The business object format file type. The file type must be known by the system. It is required when businessObjectFormatUsage is present

,

storageName (string):

The name of the storage that this storage policy applies to. The storage with this name must already exist. Currently, only S3 storage platform type is supported by the storage policies

}
storagePolicyTransition {

destinationStorageName (string):

The name of the destination storage. The storage with this name must already exist. Currently, only GLACIER storage platform type is supported for the destination storage by the storage policies

}

{
  "id": 0,
  "storagePolicyKey": {
    "namespace": "string",
    "storagePolicyName": "string"
  },
  "storagePolicyRule": {
    "ruleType": "string",
    "ruleValue": 0
  },
  "storagePolicyFilter": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "storageName": "string"
  },
  "storagePolicyTransition": {
    "destinationStorageName": "string"
  },
  "status": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<storagePolicy>
     <id>0</id>
     <storagePolicyKey>
          <namespace>string</namespace>
          <storagePolicyName>string</storagePolicyName>
     </storagePolicyKey>
     <storagePolicyRule>
          <ruleType>string</ruleType>
          <ruleValue>0</ruleValue>
     </storagePolicyRule>
     <storagePolicyFilter>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <storageName>string</storageName>
     </storagePolicyFilter>
     <storagePolicyTransition>
          <destinationStorageName>string</destinationStorageName>
     </storagePolicyTransition>
     <status>string</status>
</storagePolicy>

Response Content Type

get /storagePolicies/namespaces/{namespace}/storagePolicyNames/{storagePolicyName}

getStoragePolicy

Implementation Notes

Gets an existing storage policy by key.

Requires READ permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace	path	string
storagePolicyName		the storage policy name	path	string

Response (Status 200)

storagePolicy {

id (integer, optional):

A system unique ID of this storage policy

,

storagePolicyKey (storagePolicyKey):

Wrapper for the storage policy unique identifiers

,

storagePolicyRule (storagePolicyRule):

Wrapper for the storage policy rule

,

storagePolicyFilter (storagePolicyFilter):

The storage policy filter to be used to select business object data

,

storagePolicyTransition (storagePolicyTransition):

The storage policy transition

,

status (string):

The status of the storage policy

}
storagePolicyKey {

namespace (string):

The namespace of the storage policy

,

storagePolicyName (string):

The name of the storage policy

}
storagePolicyRule {

ruleType (string):

The storage policy rule type. Supported rule types are: DAYS_SINCE_BDATA_REGISTERED

,

ruleValue (integer, optional):

The storage policy rule value. This parameter is required

}
storagePolicyFilter {

namespace (string, optional):

The namespace of the registered business object definition. It is required when businessObjectDefinitionName is present

,

businessObjectDefinitionName (string, optional):

The name of the registered business object definition. It is required when namespace is present

,

businessObjectFormatUsage (string, optional):

The business object format usage. The usage does not need to exist in the system. It is required when businessObjectFormatFileType is present

,

businessObjectFormatFileType (string, optional):

The business object format file type. The file type must be known by the system. It is required when businessObjectFormatUsage is present

,

storageName (string):

The name of the storage that this storage policy applies to. The storage with this name must already exist. Currently, only S3 storage platform type is supported by the storage policies

}
storagePolicyTransition {

destinationStorageName (string):

The name of the destination storage. The storage with this name must already exist. Currently, only GLACIER storage platform type is supported for the destination storage by the storage policies

}

{
  "id": 0,
  "storagePolicyKey": {
    "namespace": "string",
    "storagePolicyName": "string"
  },
  "storagePolicyRule": {
    "ruleType": "string",
    "ruleValue": 0
  },
  "storagePolicyFilter": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "storageName": "string"
  },
  "storagePolicyTransition": {
    "destinationStorageName": "string"
  },
  "status": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<storagePolicy>
     <id>0</id>
     <storagePolicyKey>
          <namespace>string</namespace>
          <storagePolicyName>string</storagePolicyName>
     </storagePolicyKey>
     <storagePolicyRule>
          <ruleType>string</ruleType>
          <ruleValue>0</ruleValue>
     </storagePolicyRule>
     <storagePolicyFilter>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <storageName>string</storageName>
     </storagePolicyFilter>
     <storagePolicyTransition>
          <destinationStorageName>string</destinationStorageName>
     </storagePolicyTransition>
     <status>string</status>
</storagePolicy>

Response Content Type

put /storagePolicies/namespaces/{namespace}/storagePolicyNames/{storagePolicyName}

updateStoragePolicy

Implementation Notes

Updates an existing storage policy by key.

Requires WRITE permission on namespace and READ permission on filter namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace	path	string
storagePolicyName		the storage policy name	path	string
storagePolicyUpdateRequest: the information needed to update the storage policy	Parameter content type: Model JSON Schema XML Example storagePolicyUpdateRequest { storagePolicyRule (storagePolicyRule): Wrapper for the storage policy rule , storagePolicyFilter (storagePolicyFilter): The storage policy filter to be used to select business object data , storagePolicyTransition (storagePolicyTransition): The storage policy transition , status (string): The status of the storage policy. Supported values are: ENABLED, DISABLED } storagePolicyRule { ruleType (string): The storage policy rule type. Supported rule types are: DAYS_SINCE_BDATA_REGISTERED , ruleValue (integer, optional): The storage policy rule value. This parameter is required } storagePolicyFilter { namespace (string, optional): The namespace of the registered business object definition. It is required when businessObjectDefinitionName is present , businessObjectDefinitionName (string, optional): The name of the registered business object definition. It is required when namespace is present , businessObjectFormatUsage (string, optional): The business object format usage. The usage does not need to exist in the system. It is required when businessObjectFormatFileType is present , businessObjectFormatFileType (string, optional): The business object format file type. The file type must be known by the system. It is required when businessObjectFormatUsage is present , storageName (string): The name of the storage that this storage policy applies to. The storage with this name must already exist. Currently, only S3 storage platform type is supported by the storage policies } storagePolicyTransition { destinationStorageName (string): The name of the destination storage. The storage with this name must already exist. Currently, only GLACIER storage platform type is supported for the destination storage by the storage policies } `{ "storagePolicyRule": { "ruleType": "string", "ruleValue": 0 }, "storagePolicyFilter": { "namespace": "string", "businessObjectDefinitionName": "string", "businessObjectFormatUsage": "string", "businessObjectFormatFileType": "string", "storageName": "string" }, "storagePolicyTransition": { "destinationStorageName": "string" }, "status": "string" }` Click to set as parameter value <?xml version="1.0" encoding="UTF-8"?> <storagePolicyUpdateRequest> <storagePolicyRule> <ruleType>string</ruleType> <ruleValue>0</ruleValue> </storagePolicyRule> <storagePolicyFilter> <namespace>string</namespace> <businessObjectDefinitionName>string</businessObjectDefinitionName> <businessObjectFormatUsage>string</businessObjectFormatUsage> <businessObjectFormatFileType>string</businessObjectFormatFileType> <storageName>string</storageName> </storagePolicyFilter> <storagePolicyTransition> <destinationStorageName>string</destinationStorageName> </storagePolicyTransition> <status>string</status> </storagePolicyUpdateRequest> Click to set as parameter value

Response (Status 200)

storagePolicy {

id (integer, optional):

A system unique ID of this storage policy

,

storagePolicyKey (storagePolicyKey):

Wrapper for the storage policy unique identifiers

,

storagePolicyRule (storagePolicyRule):

Wrapper for the storage policy rule

,

storagePolicyFilter (storagePolicyFilter):

The storage policy filter to be used to select business object data

,

storagePolicyTransition (storagePolicyTransition):

The storage policy transition

,

status (string):

The status of the storage policy

}
storagePolicyKey {

namespace (string):

The namespace of the storage policy

,

storagePolicyName (string):

The name of the storage policy

}
storagePolicyRule {

ruleType (string):

The storage policy rule type. Supported rule types are: DAYS_SINCE_BDATA_REGISTERED

,

ruleValue (integer, optional):

The storage policy rule value. This parameter is required

}
storagePolicyFilter {

namespace (string, optional):

The namespace of the registered business object definition. It is required when businessObjectDefinitionName is present

,

businessObjectDefinitionName (string, optional):

The name of the registered business object definition. It is required when namespace is present

,

businessObjectFormatUsage (string, optional):

The business object format usage. The usage does not need to exist in the system. It is required when businessObjectFormatFileType is present

,

businessObjectFormatFileType (string, optional):

The business object format file type. The file type must be known by the system. It is required when businessObjectFormatUsage is present

,

storageName (string):

The name of the storage that this storage policy applies to. The storage with this name must already exist. Currently, only S3 storage platform type is supported by the storage policies

}
storagePolicyTransition {

destinationStorageName (string):

The name of the destination storage. The storage with this name must already exist. Currently, only GLACIER storage platform type is supported for the destination storage by the storage policies

}

{
  "id": 0,
  "storagePolicyKey": {
    "namespace": "string",
    "storagePolicyName": "string"
  },
  "storagePolicyRule": {
    "ruleType": "string",
    "ruleValue": 0
  },
  "storagePolicyFilter": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "storageName": "string"
  },
  "storagePolicyTransition": {
    "destinationStorageName": "string"
  },
  "status": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<storagePolicy>
     <id>0</id>
     <storagePolicyKey>
          <namespace>string</namespace>
          <storagePolicyName>string</storagePolicyName>
     </storagePolicyKey>
     <storagePolicyRule>
          <ruleType>string</ruleType>
          <ruleValue>0</ruleValue>
     </storagePolicyRule>
     <storagePolicyFilter>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <storageName>string</storageName>
     </storagePolicyFilter>
     <storagePolicyTransition>
          <destinationStorageName>string</destinationStorageName>
     </storagePolicyTransition>
     <status>string</status>
</storagePolicy>

Response Content Type

Storage Unit

get /storageUnits/download/credential/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/businessObjectDataVersions/{businessObjectDataVersion}/storageNames/{storageName}

getStorageUnitDownloadCredential

Implementation Notes

Gets the AWS credential to download to the specified storage unit.

Requires READ permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
partitionValue	the partition value	path	string
businessObjectDataVersion	the business object data version	path	integer
storageName	the storage name	path	string
subPartitionValues	the sub-partition values	query	string

Response (Status 200)

storageUnitDownloadCredential {

awsCredential (awsCredential):

The AWS session credential

}
awsCredential {

awsAccessKey (string):

The temporary AWS access key

,

awsSecretKey (string):

The temporary AWS secret key

,

awsSessionToken (string):

The temporary AWS session token

,

awsSessionExpirationTime (string):

The temporary AWS credential expiration time

}

{
  "awsCredential": {
    "awsAccessKey": "string",
    "awsSecretKey": "string",
    "awsSessionToken": "string",
    "awsSessionExpirationTime": "2017-04-29T14:40:27.116Z"
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<storageUnitDownloadCredential>
     <awsCredential>
          <awsAccessKey>string</awsAccessKey>
          <awsSecretKey>string</awsSecretKey>
          <awsSessionToken>string</awsSessionToken>
          <awsSessionExpirationTime>2015-12-25T00:00:00.000-05:00</awsSessionExpirationTime>
     </awsCredential>
</storageUnitDownloadCredential>

Response Content Type

get /storageUnits/upload/credential/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/businessObjectDataVersions/{businessObjectDataVersion}/storageNames/{storageName}

getStorageUnitUploadCredential

Implementation Notes

Gets the AWS credential to upload to the specified storage unit.

Requires WRITE permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace	path	string
businessObjectDefinitionName	the business object definition name	path	string
businessObjectFormatUsage	the business object format usage	path	string
businessObjectFormatFileType	the business object format file type	path	string
businessObjectFormatVersion	the business object format version	path	integer
partitionValue	the partition value	path	string
businessObjectDataVersion	the business object data version	path	integer
storageName	the storage name	path	string
subPartitionValues	the sub-partition values	query	string

Response (Status 200)

storageUnitUploadCredential {

awsCredential (awsCredential):

The AWS session credential

,

awsKmsKeyId (string, optional):

The AWS KMS key ID that must be used to upload, if applicable

}
awsCredential {

awsAccessKey (string):

The temporary AWS access key

,

awsSecretKey (string):

The temporary AWS secret key

,

awsSessionToken (string):

The temporary AWS session token

,

awsSessionExpirationTime (string):

The temporary AWS credential expiration time

}

{
  "awsCredential": {
    "awsAccessKey": "string",
    "awsSecretKey": "string",
    "awsSessionToken": "string",
    "awsSessionExpirationTime": "2017-04-29T14:40:27.120Z"
  },
  "awsKmsKeyId": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<storageUnitUploadCredential>
     <awsCredential>
          <awsAccessKey>string</awsAccessKey>
          <awsSecretKey>string</awsSecretKey>
          <awsSessionToken>string</awsSessionToken>
          <awsSessionExpirationTime>2015-12-25T00:00:00.000-05:00</awsSessionExpirationTime>
     </awsCredential>
     <awsKmsKeyId>string</awsKmsKeyId>
</storageUnitUploadCredential>

Response Content Type

Storage Unit Notification Registration

get /notificationRegistrations/storageUnitNotificationRegistrations

getStorageUnitNotificationRegistrationsByNotificationFilter

Implementation Notes

Gets a list of keys for all existing storage unit notification registrations that match the specified storage unit notification filter parameters.

This endpoint requires both namespace and name of the business object definition.

Requires READ permission on business object definition namespace

Parameters

Parameter	Description	Parameter Type	Data Type
businessObjectDefinitionNamespace	the namespace of the business object definition	query	string
businessObjectDefinitionName	the name of the business object definition	query	string
businessObjectFormatUsage	the usage of the business object format	query	string
businessObjectFormatFileType	the file type of the business object format	query	string

Response (Status 200)

storageUnitNotificationRegistrationKeys {

storageUnitNotificationRegistrationKeys (Array[notificationRegistrationKey], optional)

}
notificationRegistrationKey {

namespace (string),

notificationName (string)

}

{
  "storageUnitNotificationRegistrationKeys": [
    {
      "namespace": "string",
      "notificationName": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<storageUnitNotificationRegistrationKeys>
     <storageUnitNotificationRegistrationKey>
          <namespace>string</namespace>
          <notificationName>string</notificationName>
     </storageUnitNotificationRegistrationKey>
</storageUnitNotificationRegistrationKeys>

Response Content Type

post /notificationRegistrations/storageUnitNotificationRegistrations

createStorageUnitNotificationRegistration

Implementation Notes

Creates a new storage unit notification registration.

Requires WRITE permission on namespace

Requires READ permission on filter namespace

Requires EXECUTE permission on ALL job action namespaces

Parameter (body): the information needed to create the storage unit notification registration

Parameter content type:

storageUnitNotificationRegistrationCreateRequest {

storageUnitNotificationRegistrationKey (notificationRegistrationKey):

A unique identifier for a storage unit notification registration

,

storageUnitEventType (string):

              The type of storage unit event in which this notification should trigger. Supported event types: STRGE_UNIT_STTS_CHG

,

storageUnitNotificationFilter (storageUnitNotificationFilter):

              The filter to use against storage unit events. The notification will only trigger for events matching this filter

,

jobActions (Array[jobAction], optional):

The list of jobs to execute when this notification is triggered

,

notificationRegistrationStatus (string, optional):

              The status of the notification registration. One of the following values: ENABLED or DISABLED. Default value is ENABLED

}
notificationRegistrationKey {

namespace (string),

notificationName (string)

}
storageUnitNotificationFilter {

namespace (string):

The namespace of the business object definition

,

businessObjectDefinitionName (string):

The business object definition name

,

businessObjectFormatUsage (string, optional):

The business object format usage

,

businessObjectFormatFileType (string, optional):

The business object format file type

,

businessObjectFormatVersion (integer, optional):

The business object format version

,

storageName (string):

The storage name

,

newStorageUnitStatus (string, optional):

              The new storage unit status. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

,

oldStorageUnitStatus (string, optional):

              The old storage unit status. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

}
jobAction {

namespace (string):

The namespace

,

jobName (string):

The job name

,

correlationData (string, optional):

The correlation data

}

{
  "storageUnitNotificationRegistrationKey": {
    "namespace": "string",
    "notificationName": "string"
  },
  "storageUnitEventType": "string",
  "storageUnitNotificationFilter": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "storageName": "string",
    "newStorageUnitStatus": "string",
    "oldStorageUnitStatus": "string"
  },
  "jobActions": [
    {
      "namespace": "string",
      "jobName": "string",
      "correlationData": "string"
    }
  ],
  "notificationRegistrationStatus": "string"
}

Click to set as parameter value

<?xml version="1.0" encoding="UTF-8"?>
<storageUnitNotificationRegistrationCreateRequest>
     <storageUnitNotificationRegistrationKey>
          <namespace>string</namespace>
          <notificationName>string</notificationName>
     </storageUnitNotificationRegistrationKey>
     <storageUnitEventType>string</storageUnitEventType>
     <storageUnitNotificationFilter>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <storageName>string</storageName>
          <newStorageUnitStatus>string</newStorageUnitStatus>
          <oldStorageUnitStatus>string</oldStorageUnitStatus>
     </storageUnitNotificationFilter>
     <jobActions>
          <jobAction>
               <namespace>string</namespace>
               <jobName>string</jobName>
               <correlationData>
        <![CDATA[
        string]]>
      </correlationData>
          </jobAction>
     </jobActions>
     <notificationRegistrationStatus>string</notificationRegistrationStatus>
</storageUnitNotificationRegistrationCreateRequest>

Click to set as parameter value

Response (Status 200)

storageUnitNotificationRegistration {

id (integer, optional):

A system unique ID of this registration

,

storageUnitNotificationRegistrationKey (notificationRegistrationKey):

A unique identifier for a storage unit notification registration

,

storageUnitEventType (string):

              The type of storage unit event in which this notification should trigger. Supported event types: STRGE_UNIT_STTS_CHG

,

storageUnitNotificationFilter (storageUnitNotificationFilter):

              The filter to use against storage unit events. The notification will only trigger for events matching this filter

,

jobActions (Array[jobAction], optional):

The list of jobs to execute when this notification is triggered

,

notificationRegistrationStatus (string):

              The status of the notification registration. One of the following values: ENABLED or DISABLED

}
notificationRegistrationKey {

namespace (string),

notificationName (string)

}
storageUnitNotificationFilter {

namespace (string):

The namespace of the business object definition

,

businessObjectDefinitionName (string):

The business object definition name

,

businessObjectFormatUsage (string, optional):

The business object format usage

,

businessObjectFormatFileType (string, optional):

The business object format file type

,

businessObjectFormatVersion (integer, optional):

The business object format version

,

storageName (string):

The storage name

,

newStorageUnitStatus (string, optional):

              The new storage unit status. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

,

oldStorageUnitStatus (string, optional):

              The old storage unit status. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

}
jobAction {

namespace (string):

The namespace

,

jobName (string):

The job name

,

correlationData (string, optional):

The correlation data

}

{
  "id": 0,
  "storageUnitNotificationRegistrationKey": {
    "namespace": "string",
    "notificationName": "string"
  },
  "storageUnitEventType": "string",
  "storageUnitNotificationFilter": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "storageName": "string",
    "newStorageUnitStatus": "string",
    "oldStorageUnitStatus": "string"
  },
  "jobActions": [
    {
      "namespace": "string",
      "jobName": "string",
      "correlationData": "string"
    }
  ],
  "notificationRegistrationStatus": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<storageUnitNotificationRegistration>
     <id>0</id>
     <storageUnitNotificationRegistrationKey>
          <namespace>string</namespace>
          <notificationName>string</notificationName>
     </storageUnitNotificationRegistrationKey>
     <storageUnitEventType>string</storageUnitEventType>
     <storageUnitNotificationFilter>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <storageName>string</storageName>
          <newStorageUnitStatus>string</newStorageUnitStatus>
          <oldStorageUnitStatus>string</oldStorageUnitStatus>
     </storageUnitNotificationFilter>
     <jobActions>
          <jobAction>
               <namespace>string</namespace>
               <jobName>string</jobName>
               <correlationData>
        <![CDATA[
        string]]>
      </correlationData>
          </jobAction>
     </jobActions>
     <notificationRegistrationStatus>string</notificationRegistrationStatus>
</storageUnitNotificationRegistration>

Response Content Type

get /notificationRegistrations/storageUnitNotificationRegistrations/namespaces/{namespace}

getStorageUnitNotificationRegistrationsByNamespace

delete /notificationRegistrations/storageUnitNotificationRegistrations/namespaces/{namespace}/notificationNames/{notificationName}

deleteStorageUnitNotification

Implementation Notes

Deletes an existing storage unit notification registration by key.

Requires WRITE permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace of the storage unit notification registration	path	string
notificationName		the name of the storage unit notification registration	path	string

Response (Status 200)

storageUnitNotificationRegistration {

id (integer, optional):

A system unique ID of this registration

,

storageUnitNotificationRegistrationKey (notificationRegistrationKey):

A unique identifier for a storage unit notification registration

,

storageUnitEventType (string):

              The type of storage unit event in which this notification should trigger. Supported event types: STRGE_UNIT_STTS_CHG

,

storageUnitNotificationFilter (storageUnitNotificationFilter):

              The filter to use against storage unit events. The notification will only trigger for events matching this filter

,

jobActions (Array[jobAction], optional):

The list of jobs to execute when this notification is triggered

,

notificationRegistrationStatus (string):

              The status of the notification registration. One of the following values: ENABLED or DISABLED

}
notificationRegistrationKey {

namespace (string),

notificationName (string)

}
storageUnitNotificationFilter {

namespace (string):

The namespace of the business object definition

,

businessObjectDefinitionName (string):

The business object definition name

,

businessObjectFormatUsage (string, optional):

The business object format usage

,

businessObjectFormatFileType (string, optional):

The business object format file type

,

businessObjectFormatVersion (integer, optional):

The business object format version

,

storageName (string):

The storage name

,

newStorageUnitStatus (string, optional):

              The new storage unit status. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

,

oldStorageUnitStatus (string, optional):

              The old storage unit status. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

}
jobAction {

namespace (string):

The namespace

,

jobName (string):

The job name

,

correlationData (string, optional):

The correlation data

}

{
  "id": 0,
  "storageUnitNotificationRegistrationKey": {
    "namespace": "string",
    "notificationName": "string"
  },
  "storageUnitEventType": "string",
  "storageUnitNotificationFilter": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "storageName": "string",
    "newStorageUnitStatus": "string",
    "oldStorageUnitStatus": "string"
  },
  "jobActions": [
    {
      "namespace": "string",
      "jobName": "string",
      "correlationData": "string"
    }
  ],
  "notificationRegistrationStatus": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<storageUnitNotificationRegistration>
     <id>0</id>
     <storageUnitNotificationRegistrationKey>
          <namespace>string</namespace>
          <notificationName>string</notificationName>
     </storageUnitNotificationRegistrationKey>
     <storageUnitEventType>string</storageUnitEventType>
     <storageUnitNotificationFilter>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <storageName>string</storageName>
          <newStorageUnitStatus>string</newStorageUnitStatus>
          <oldStorageUnitStatus>string</oldStorageUnitStatus>
     </storageUnitNotificationFilter>
     <jobActions>
          <jobAction>
               <namespace>string</namespace>
               <jobName>string</jobName>
               <correlationData>
        <![CDATA[
        string]]>
      </correlationData>
          </jobAction>
     </jobActions>
     <notificationRegistrationStatus>string</notificationRegistrationStatus>
</storageUnitNotificationRegistration>

Response Content Type

get /notificationRegistrations/storageUnitNotificationRegistrations/namespaces/{namespace}/notificationNames/{notificationName}

getStorageUnitNotificationRegistration

Implementation Notes

Gets an existing storage unit notification registration by key.

Requires READ permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace of the storage unit notification registration	path	string
notificationName		the name of the storage unit notification registration	path	string

Response (Status 200)

storageUnitNotificationRegistration {

id (integer, optional):

A system unique ID of this registration

,

storageUnitNotificationRegistrationKey (notificationRegistrationKey):

A unique identifier for a storage unit notification registration

,

storageUnitEventType (string):

              The type of storage unit event in which this notification should trigger. Supported event types: STRGE_UNIT_STTS_CHG

,

storageUnitNotificationFilter (storageUnitNotificationFilter):

              The filter to use against storage unit events. The notification will only trigger for events matching this filter

,

jobActions (Array[jobAction], optional):

The list of jobs to execute when this notification is triggered

,

notificationRegistrationStatus (string):

              The status of the notification registration. One of the following values: ENABLED or DISABLED

}
notificationRegistrationKey {

namespace (string),

notificationName (string)

}
storageUnitNotificationFilter {

namespace (string):

The namespace of the business object definition

,

businessObjectDefinitionName (string):

The business object definition name

,

businessObjectFormatUsage (string, optional):

The business object format usage

,

businessObjectFormatFileType (string, optional):

The business object format file type

,

businessObjectFormatVersion (integer, optional):

The business object format version

,

storageName (string):

The storage name

,

newStorageUnitStatus (string, optional):

              The new storage unit status. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

,

oldStorageUnitStatus (string, optional):

              The old storage unit status. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

}
jobAction {

namespace (string):

The namespace

,

jobName (string):

The job name

,

correlationData (string, optional):

The correlation data

}

{
  "id": 0,
  "storageUnitNotificationRegistrationKey": {
    "namespace": "string",
    "notificationName": "string"
  },
  "storageUnitEventType": "string",
  "storageUnitNotificationFilter": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "storageName": "string",
    "newStorageUnitStatus": "string",
    "oldStorageUnitStatus": "string"
  },
  "jobActions": [
    {
      "namespace": "string",
      "jobName": "string",
      "correlationData": "string"
    }
  ],
  "notificationRegistrationStatus": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<storageUnitNotificationRegistration>
     <id>0</id>
     <storageUnitNotificationRegistrationKey>
          <namespace>string</namespace>
          <notificationName>string</notificationName>
     </storageUnitNotificationRegistrationKey>
     <storageUnitEventType>string</storageUnitEventType>
     <storageUnitNotificationFilter>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <storageName>string</storageName>
          <newStorageUnitStatus>string</newStorageUnitStatus>
          <oldStorageUnitStatus>string</oldStorageUnitStatus>
     </storageUnitNotificationFilter>
     <jobActions>
          <jobAction>
               <namespace>string</namespace>
               <jobName>string</jobName>
               <correlationData>
        <![CDATA[
        string]]>
      </correlationData>
          </jobAction>
     </jobActions>
     <notificationRegistrationStatus>string</notificationRegistrationStatus>
</storageUnitNotificationRegistration>

Response Content Type

put /notificationRegistrations/storageUnitNotificationRegistrations/namespaces/{namespace}/notificationNames/{notificationName}

updateStorageUnitNotificationRegistration

Implementation Notes

Updates an existing storage unit notification registration by key.

Requires WRITE permission on namespace

Requires READ permission on filter namespace

Requires EXECUTE permission on ALL job action namespaces

Parameters

Parameter Value Description Parameter Type Data Type

namespace

the namespace of the storage unit notification registration

path

string

notificationName

the name of the storage unit notification registration

path

string

storageUnitNotificationRegistrationUpdateRequest:

the information needed to update the storage unit notification registration

Parameter content type:

storageUnitNotificationRegistrationUpdateRequest {

storageUnitEventType (string):

              The type of storage unit event in which this notification should trigger. Supported event types: STRGE_UNIT_STTS_CHG

,

storageUnitNotificationFilter (storageUnitNotificationFilter):

              The filter to use against storage unit events. The notification will only trigger for events matching this filter

,

jobActions (Array[jobAction], optional):

The list of jobs to execute when this notification is triggered

,

notificationRegistrationStatus (string):

              The status of the notification registration. One of the following values: ENABLED or DISABLED

}
storageUnitNotificationFilter {

namespace (string):

The namespace of the business object definition

,

businessObjectDefinitionName (string):

The business object definition name

,

businessObjectFormatUsage (string, optional):

The business object format usage

,

businessObjectFormatFileType (string, optional):

The business object format file type

,

businessObjectFormatVersion (integer, optional):

The business object format version

,

storageName (string):

The storage name

,

newStorageUnitStatus (string, optional):

              The new storage unit status. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

,

oldStorageUnitStatus (string, optional):

              The old storage unit status. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

}
jobAction {

namespace (string):

The namespace

,

jobName (string):

The job name

,

correlationData (string, optional):

The correlation data

}

{
  "storageUnitEventType": "string",
  "storageUnitNotificationFilter": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "storageName": "string",
    "newStorageUnitStatus": "string",
    "oldStorageUnitStatus": "string"
  },
  "jobActions": [
    {
      "namespace": "string",
      "jobName": "string",
      "correlationData": "string"
    }
  ],
  "notificationRegistrationStatus": "string"
}

Click to set as parameter value

<?xml version="1.0" encoding="UTF-8"?>
<storageUnitNotificationRegistrationUpdateRequest>
     <storageUnitEventType>string</storageUnitEventType>
     <storageUnitNotificationFilter>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <storageName>string</storageName>
          <newStorageUnitStatus>string</newStorageUnitStatus>
          <oldStorageUnitStatus>string</oldStorageUnitStatus>
     </storageUnitNotificationFilter>
     <jobActions>
          <jobAction>
               <namespace>string</namespace>
               <jobName>string</jobName>
               <correlationData>
        <![CDATA[
        string]]>
      </correlationData>
          </jobAction>
     </jobActions>
     <notificationRegistrationStatus>string</notificationRegistrationStatus>
</storageUnitNotificationRegistrationUpdateRequest>

Click to set as parameter value

Response (Status 200)

storageUnitNotificationRegistration {

id (integer, optional):

A system unique ID of this registration

,

storageUnitNotificationRegistrationKey (notificationRegistrationKey):

A unique identifier for a storage unit notification registration

,

storageUnitEventType (string):

              The type of storage unit event in which this notification should trigger. Supported event types: STRGE_UNIT_STTS_CHG

,

storageUnitNotificationFilter (storageUnitNotificationFilter):

              The filter to use against storage unit events. The notification will only trigger for events matching this filter

,

jobActions (Array[jobAction], optional):

The list of jobs to execute when this notification is triggered

,

notificationRegistrationStatus (string):

              The status of the notification registration. One of the following values: ENABLED or DISABLED

}
notificationRegistrationKey {

namespace (string),

notificationName (string)

}
storageUnitNotificationFilter {

namespace (string):

The namespace of the business object definition

,

businessObjectDefinitionName (string):

The business object definition name

,

businessObjectFormatUsage (string, optional):

The business object format usage

,

businessObjectFormatFileType (string, optional):

The business object format file type

,

businessObjectFormatVersion (integer, optional):

The business object format version

,

storageName (string):

The storage name

,

newStorageUnitStatus (string, optional):

              The new storage unit status. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

,

oldStorageUnitStatus (string, optional):

              The old storage unit status. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

}
jobAction {

namespace (string):

The namespace

,

jobName (string):

The job name

,

correlationData (string, optional):

The correlation data

}

{
  "id": 0,
  "storageUnitNotificationRegistrationKey": {
    "namespace": "string",
    "notificationName": "string"
  },
  "storageUnitEventType": "string",
  "storageUnitNotificationFilter": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "businessObjectFormatUsage": "string",
    "businessObjectFormatFileType": "string",
    "businessObjectFormatVersion": 0,
    "storageName": "string",
    "newStorageUnitStatus": "string",
    "oldStorageUnitStatus": "string"
  },
  "jobActions": [
    {
      "namespace": "string",
      "jobName": "string",
      "correlationData": "string"
    }
  ],
  "notificationRegistrationStatus": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<storageUnitNotificationRegistration>
     <id>0</id>
     <storageUnitNotificationRegistrationKey>
          <namespace>string</namespace>
          <notificationName>string</notificationName>
     </storageUnitNotificationRegistrationKey>
     <storageUnitEventType>string</storageUnitEventType>
     <storageUnitNotificationFilter>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <storageName>string</storageName>
          <newStorageUnitStatus>string</newStorageUnitStatus>
          <oldStorageUnitStatus>string</oldStorageUnitStatus>
     </storageUnitNotificationFilter>
     <jobActions>
          <jobAction>
               <namespace>string</namespace>
               <jobName>string</jobName>
               <correlationData>
        <![CDATA[
        string]]>
      </correlationData>
          </jobAction>
     </jobActions>
     <notificationRegistrationStatus>string</notificationRegistrationStatus>
</storageUnitNotificationRegistration>

Response Content Type

Subject Matter Expert

get /subjectMatterExperts/{userId}

getSubjectMatterExpert

Implementation Notes

Gets information for the specified subject matter expert.

Parameters

Parameter	Value	Description	Parameter Type	Data Type
userId		the user id of the subject matter expert	path	string

Response (Status 200)

subjectMatterExpert {

subjectMatterExpertKey (subjectMatterExpertKey):

Values that uniquely identify a Subject Matter Expert

,

contactDetails (subjectMatterExpertContactDetails):

The contact details of the Subject Matter Expert

}
subjectMatterExpertKey {

userId (string):

The user id of the Subject Matter Expert. This must be a fully qualified name as the value will be utilized to look up contact information in LDAP

}
subjectMatterExpertContactDetails {

fullName (string, optional):

The full name of the Subject Matter Expert

,

jobTitle (string, optional):

The job title of the Subject Matter Expert

,

emailAddress (string, optional):

The e-mail address of the Subject Matter Expert

,

telephoneNumber (string, optional):

The telephone number of the Subject Matter Expert

}

{
  "subjectMatterExpertKey": {
    "userId": "string"
  },
  "contactDetails": {
    "fullName": "string",
    "jobTitle": "string",
    "emailAddress": "string",
    "telephoneNumber": "string"
  }
}

<?xml version="1.0" encoding="UTF-8"?>
<subjectMatterExpert>
     <subjectMatterExpertKey>
          <userId>string</userId>
     </subjectMatterExpertKey>
     <contactDetails>
          <fullName>string</fullName>
          <jobTitle>string</jobTitle>
          <emailAddress>string</emailAddress>
          <telephoneNumber>string</telephoneNumber>
     </contactDetails>
</subjectMatterExpert>

Response Content Type

System Job

post /systemJobs

runSystemJob

Implementation Notes

Starts a system job asynchronously.

Parameter (body): the information needed to run the system job

Parameter content type:

systemJobRunRequest {

jobName (string),

parameters (Array[parameter], optional)

}
parameter {

name (string):

              Name of the parameter

,

value (string, optional):

              Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the
              application logs

}

{
  "jobName": "string",
  "parameters": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

Click to set as parameter value

<?xml version="1.0" encoding="UTF-8"?>
<systemJobRunRequest>
     <jobName>string</jobName>
     <parameters>
          <parameter>
               <name>string</name>
               <value>string</value>
          </parameter>
     </parameters>
</systemJobRunRequest>

Click to set as parameter value

Response (Status 200)

systemJobRunResponse {

jobName (string),

parameters (Array[parameter], optional)

}
parameter {

name (string):

              Name of the parameter

,

value (string, optional):

              Value of the parameter. If the name of the parameter contains the word "password," this value will be masked before being logged into the
              application logs

}

{
  "jobName": "string",
  "parameters": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<systemJobRunResponse>
     <jobName>string</jobName>
     <parameters>
          <parameter>
               <name>string</name>
               <value>string</value>
          </parameter>
     </parameters>
</systemJobRunResponse>

Response Content Type

Tag

post /tags

createTag

Implementation Notes

Creates a new tag.

Parameter (body): the information needed to create the tag
Parameter content type: Model JSON Schema XML Example tagCreateRequest { tagKey (tagKey): The tag's unique key , displayName (string): The tag's name in plain text for human readability , description (string, optional): An optional description , parentTagKey (tagKey, optional): An optional parent tag's unique key } tagKey { tagTypeCode (string): The tag type reference code , tagCode (string): The tag reference code } `{ "tagKey": { "tagTypeCode": "string", "tagCode": "string" }, "displayName": "string", "description": "string", "parentTagKey": { "tagTypeCode": "string", "tagCode": "string" } }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <tagCreateRequest> <tagKey> <tagTypeCode>string</tagTypeCode> <tagCode>string</tagCode> </tagKey> <displayName>string</displayName> <description>string</description> <parentTagKey> <tagTypeCode>string</tagTypeCode> <tagCode>string</tagCode> </parentTagKey> </tagCreateRequest>` Click to set as parameter value

Response (Status 200)

tag {

id (integer, optional):

The internal identifier that uniquely references a Tag

,

tagKey (tagKey):

The tag's unique key

,

displayName (string, optional):

The tag's name in plain text for human readability

,

description (string, optional):

The tag's description

,

userId (string, optional):

The User ID of the user who created this tag

,

lastUpdatedByUserId (string, optional):

The User ID of the user who last updated this tag

,

updatedTime (string, optional):

The timestamp of when it is last updated

,

parentTagKey (tagKey, optional):

The parent tag's unique key

,

hasChildren (boolean, optional):

A boolean flag that shows whether this tag has further children

}
tagKey {

tagTypeCode (string):

The tag type reference code

,

tagCode (string):

The tag reference code

}

{
  "id": 0,
  "tagKey": {
    "tagTypeCode": "string",
    "tagCode": "string"
  },
  "displayName": "string",
  "description": "string",
  "userId": "string",
  "lastUpdatedByUserId": "string",
  "updatedTime": "2017-04-29T14:40:27.152Z",
  "parentTagKey": {
    "tagTypeCode": "string",
    "tagCode": "string"
  },
  "hasChildren": true
}

<?xml version="1.0" encoding="UTF-8"?>
<tag>
     <id>0</id>
     <tagKey>
          <tagTypeCode>string</tagTypeCode>
          <tagCode>string</tagCode>
     </tagKey>
     <displayName>string</displayName>
     <description>string</description>
     <userId>string</userId>
     <lastUpdatedByUserId>string</lastUpdatedByUserId>
     <updatedTime>2015-12-25T00:00:00.000-05:00</updatedTime>
     <parentTagKey>
          <tagTypeCode>string</tagTypeCode>
          <tagCode>string</tagCode>
     </parentTagKey>
     <hasChildren>true</hasChildren>
</tag>

Response Content Type

post /tags/search

searchTags

Implementation Notes

Retrieves all tags existing in the system per specified search filters and keys. For each tag entity, this endpoint returns tag key by default along with any other top-level elements as specified by the "fields" query string parameter. The list of tags returned by this endpoint is sorted alphabetically by tag's display name ascending.

Parameters

Parameter	Value	Description	Parameter Type	Data Type
tagSearchRequest: the tag search request. The request can only accept a single search filter and a single search key	Parameter content type: Model JSON Schema XML Example tagSearchRequest { tagSearchFilters (Array[tagSearchFilter], optional): A list of tag search filters. Only a single optional search filter is supported } tagSearchFilter { tagSearchKeys (Array[tagSearchKey], optional): A list of tag search keys. Only a single search key is supported } tagSearchKey { tagTypeCode (string): The tag type reference code , parentTagCode (string, optional): An optional tag reference code of the parent tag , isParentTagNull (boolean, optional): An optional boolean flag that specifies if parent tag should not be set for the tags that we want to retrieve } `{ "tagSearchFilters": [ { "tagSearchKeys": [ { "tagTypeCode": "string", "parentTagCode": "string", "isParentTagNull": true } ] } ] }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <tagSearchRequest> <tagSearchFilters> <tagSearchFilter> <tagSearchKeys> <tagSearchKey> <tagTypeCode>string</tagTypeCode> <parentTagCode>string</parentTagCode> <isParentTagNull>true</isParentTagNull> </tagSearchKey> </tagSearchKeys> </tagSearchFilter> </tagSearchFilters> </tagSearchRequest>` Click to set as parameter value
fields		the field options for the tag type search response. The valid field options are: displayName, description, parentTagKey, hasChildren	query	string

Response (Status 200)

tagSearchResponse {

tags (Array[tag], optional):

An ordered list of tags. The list is sorted alphabetically by tag's display name ascending

}
tag {

id (integer, optional):

The internal identifier that uniquely references a Tag

,

tagKey (tagKey):

The tag's unique key

,

displayName (string, optional):

The tag's name in plain text for human readability

,

description (string, optional):

The tag's description

,

userId (string, optional):

The User ID of the user who created this tag

,

lastUpdatedByUserId (string, optional):

The User ID of the user who last updated this tag

,

updatedTime (string, optional):

The timestamp of when it is last updated

,

parentTagKey (tagKey, optional):

The parent tag's unique key

,

hasChildren (boolean, optional):

A boolean flag that shows whether this tag has further children

}
tagKey {

tagTypeCode (string):

The tag type reference code

,

tagCode (string):

The tag reference code

}

{
  "tags": [
    "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<tag>\n   <id>0</id>\n   <tagKey>\n      <tagTypeCode>string</tagTypeCode>\n      <tagCode>string</tagCode>\n   </tagKey>\n   <displayName>string</displayName>\n   <description>string</description>\n   <userId>string</userId>\n   <lastUpdatedByUserId>string</lastUpdatedByUserId>\n   <updatedTime>2015-12-25T00:00:00.000-05:00</updatedTime>\n   <parentTagKey>\n      <tagTypeCode>string</tagTypeCode>\n      <tagCode>string</tagCode>\n   </parentTagKey>\n   <hasChildren>true</hasChildren>\n</tag>\n"
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<tagSearchResponse>
     <tags>
          <tag>
               <id>0</id>
               <tagKey>
                    <tagTypeCode>string</tagTypeCode>
                    <tagCode>string</tagCode>
               </tagKey>
               <displayName>string</displayName>
               <description>string</description>
               <userId>string</userId>
               <lastUpdatedByUserId>string</lastUpdatedByUserId>
               <updatedTime>2015-12-25T00:00:00.000-05:00</updatedTime>
               <parentTagKey>
                    <tagTypeCode>string</tagTypeCode>
                    <tagCode>string</tagCode>
               </parentTagKey>
               <hasChildren>true</hasChildren>
          </tag>
     </tags>
</tagSearchResponse>

Response Content Type

get /tags/tagTypes/{tagTypeCode}

getTags

Implementation Notes

Retrieves all associated tags for the specified tag type code. When tagCode is null, return all tags of the tag type code, which has no parent (i.e. root tags). When tagCode is provided, return all tags of the tag type code and whose parent tag code is tagCode.

Parameters

Parameter	Value	Description	Parameter Type	Data Type
tagTypeCode		the tag type's code.	path	string
tagCode		the parent tag code.	query	string

Response (Status 200)

tagListResponse {

tagKey (tagKey, optional):

The tag's unique key

,

parentTagKey (tagKey, optional):

The parent tag's unique key

,

tagChildren (Array[tagChild], optional):

The list of children tags

}
tagKey {

tagTypeCode (string):

The tag type reference code

,

tagCode (string):

The tag reference code

}
tagChild {

tagKey (tagKey):

The tag's unique key

,

hasChildren (boolean, optional):

A boolean flag that shows whether this tag has further children

}

{
  "tagKey": {
    "tagTypeCode": "string",
    "tagCode": "string"
  },
  "parentTagKey": {
    "tagTypeCode": "string",
    "tagCode": "string"
  },
  "tagChildren": [
    {
      "tagKey": {
        "tagTypeCode": "string",
        "tagCode": "string"
      },
      "hasChildren": true
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<tagListResponse>
     <tagKey>
          <tagTypeCode>string</tagTypeCode>
          <tagCode>string</tagCode>
     </tagKey>
     <parentTagKey>
          <tagTypeCode>string</tagTypeCode>
          <tagCode>string</tagCode>
     </parentTagKey>
     <tagChildren>
          <tagChild>
               <tagKey>
                    <tagTypeCode>string</tagTypeCode>
                    <tagCode>string</tagCode>
               </tagKey>
               <hasChildren>true</hasChildren>
          </tagChild>
     </tagChildren>
</tagListResponse>

Response Content Type

delete /tags/tagTypes/{tagTypeCode}/tagCodes/{tagCode}

deleteTag

Implementation Notes

Deletes an existing tag.

Parameters

Parameter	Value	Description	Parameter Type	Data Type
tagTypeCode		the tag type code	path	string
tagCode		the tag code	path	string

Response (Status 200)

tag {

id (integer, optional):

The internal identifier that uniquely references a Tag

,

tagKey (tagKey):

The tag's unique key

,

displayName (string, optional):

The tag's name in plain text for human readability

,

description (string, optional):

The tag's description

,

userId (string, optional):

The User ID of the user who created this tag

,

lastUpdatedByUserId (string, optional):

The User ID of the user who last updated this tag

,

updatedTime (string, optional):

The timestamp of when it is last updated

,

parentTagKey (tagKey, optional):

The parent tag's unique key

,

hasChildren (boolean, optional):

A boolean flag that shows whether this tag has further children

}
tagKey {

tagTypeCode (string):

The tag type reference code

,

tagCode (string):

The tag reference code

}

{
  "id": 0,
  "tagKey": {
    "tagTypeCode": "string",
    "tagCode": "string"
  },
  "displayName": "string",
  "description": "string",
  "userId": "string",
  "lastUpdatedByUserId": "string",
  "updatedTime": "2017-04-29T14:40:27.160Z",
  "parentTagKey": {
    "tagTypeCode": "string",
    "tagCode": "string"
  },
  "hasChildren": true
}

<?xml version="1.0" encoding="UTF-8"?>
<tag>
     <id>0</id>
     <tagKey>
          <tagTypeCode>string</tagTypeCode>
          <tagCode>string</tagCode>
     </tagKey>
     <displayName>string</displayName>
     <description>string</description>
     <userId>string</userId>
     <lastUpdatedByUserId>string</lastUpdatedByUserId>
     <updatedTime>2015-12-25T00:00:00.000-05:00</updatedTime>
     <parentTagKey>
          <tagTypeCode>string</tagTypeCode>
          <tagCode>string</tagCode>
     </parentTagKey>
     <hasChildren>true</hasChildren>
</tag>

Response Content Type

get /tags/tagTypes/{tagTypeCode}/tagCodes/{tagCode}

getTag

Implementation Notes

Gets an existing tag.

Parameters

Parameter	Value	Description	Parameter Type	Data Type
tagTypeCode		the tag type code	path	string
tagCode		the tag code	path	string

Response (Status 200)

tag {

id (integer, optional):

The internal identifier that uniquely references a Tag

,

tagKey (tagKey):

The tag's unique key

,

displayName (string, optional):

The tag's name in plain text for human readability

,

description (string, optional):

The tag's description

,

userId (string, optional):

The User ID of the user who created this tag

,

lastUpdatedByUserId (string, optional):

The User ID of the user who last updated this tag

,

updatedTime (string, optional):

The timestamp of when it is last updated

,

parentTagKey (tagKey, optional):

The parent tag's unique key

,

hasChildren (boolean, optional):

A boolean flag that shows whether this tag has further children

}
tagKey {

tagTypeCode (string):

The tag type reference code

,

tagCode (string):

The tag reference code

}

{
  "id": 0,
  "tagKey": {
    "tagTypeCode": "string",
    "tagCode": "string"
  },
  "displayName": "string",
  "description": "string",
  "userId": "string",
  "lastUpdatedByUserId": "string",
  "updatedTime": "2017-04-29T14:40:27.166Z",
  "parentTagKey": {
    "tagTypeCode": "string",
    "tagCode": "string"
  },
  "hasChildren": true
}

<?xml version="1.0" encoding="UTF-8"?>
<tag>
     <id>0</id>
     <tagKey>
          <tagTypeCode>string</tagTypeCode>
          <tagCode>string</tagCode>
     </tagKey>
     <displayName>string</displayName>
     <description>string</description>
     <userId>string</userId>
     <lastUpdatedByUserId>string</lastUpdatedByUserId>
     <updatedTime>2015-12-25T00:00:00.000-05:00</updatedTime>
     <parentTagKey>
          <tagTypeCode>string</tagTypeCode>
          <tagCode>string</tagCode>
     </parentTagKey>
     <hasChildren>true</hasChildren>
</tag>

Response Content Type

put /tags/tagTypes/{tagTypeCode}/tagCodes/{tagCode}

updateTag

Implementation Notes

Updates an existing tag.

Parameters

Parameter	Value	Description	Parameter Type	Data Type
tagTypeCode		the tag type code	path	string
tagCode		the tag code	path	string
tagUpdateRequest: the information needed to update the tag	Parameter content type: Model JSON Schema XML Example tagUpdateRequest { displayName (string): The tag's name in plain text for human readability , description (string, optional): An optional description , parentTagKey (tagKey, optional): An optional parent tag's unique key } tagKey { tagTypeCode (string): The tag type reference code , tagCode (string): The tag reference code } `{ "displayName": "string", "description": "string", "parentTagKey": { "tagTypeCode": "string", "tagCode": "string" } }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <tagUpdateRequest> <displayName>string</displayName> <description>string</description> <parentTagKey> <tagTypeCode>string</tagTypeCode> <tagCode>string</tagCode> </parentTagKey> </tagUpdateRequest>` Click to set as parameter value

Response (Status 200)

tag {

id (integer, optional):

The internal identifier that uniquely references a Tag

,

tagKey (tagKey):

The tag's unique key

,

displayName (string, optional):

The tag's name in plain text for human readability

,

description (string, optional):

The tag's description

,

userId (string, optional):

The User ID of the user who created this tag

,

lastUpdatedByUserId (string, optional):

The User ID of the user who last updated this tag

,

updatedTime (string, optional):

The timestamp of when it is last updated

,

parentTagKey (tagKey, optional):

The parent tag's unique key

,

hasChildren (boolean, optional):

A boolean flag that shows whether this tag has further children

}
tagKey {

tagTypeCode (string):

The tag type reference code

,

tagCode (string):

The tag reference code

}

{
  "id": 0,
  "tagKey": {
    "tagTypeCode": "string",
    "tagCode": "string"
  },
  "displayName": "string",
  "description": "string",
  "userId": "string",
  "lastUpdatedByUserId": "string",
  "updatedTime": "2017-04-29T14:40:27.168Z",
  "parentTagKey": {
    "tagTypeCode": "string",
    "tagCode": "string"
  },
  "hasChildren": true
}

<?xml version="1.0" encoding="UTF-8"?>
<tag>
     <id>0</id>
     <tagKey>
          <tagTypeCode>string</tagTypeCode>
          <tagCode>string</tagCode>
     </tagKey>
     <displayName>string</displayName>
     <description>string</description>
     <userId>string</userId>
     <lastUpdatedByUserId>string</lastUpdatedByUserId>
     <updatedTime>2015-12-25T00:00:00.000-05:00</updatedTime>
     <parentTagKey>
          <tagTypeCode>string</tagTypeCode>
          <tagCode>string</tagCode>
     </parentTagKey>
     <hasChildren>true</hasChildren>
</tag>

Response Content Type

Tag Type

- get /tagTypes
  - getTagTypes
  Implementation Notes
  
  Gets a list of tag type keys for all tag types defined in the system.
  Response (Status 200)
  Model
  
  JSON Schema
  
  XML Example
  
  tagTypeKeys {
  tagTypeKeys (Array[tagTypeKey], optional)
  }
  tagTypeKey {
  tagTypeCode (string):
  The tag type reference code
  
  }
  
  { "tagTypeKeys": [ { "tagTypeCode": "string" } ] }
  
  <?xml version="1.0" encoding="UTF-8"?> <tagTypeKeys> <tagTypeKey> <tagTypeCode>string</tagTypeCode> </tagTypeKey> </tagTypeKeys>
  Response Content Type
  
  Hide Response
  Curl
  
  Request URL
  
  Response Body
  
  Response Code

post /tagTypes

createTagType

Implementation Notes

Creates a new tag type.

Parameter (body): the information needed to create the tag type
Parameter content type: Model JSON Schema XML Example tagTypeCreateRequest { tagTypeKey (tagTypeKey): The tag type unique key , displayName (string): The tag type's name in plain text for human readability , tagTypeOrder (integer, optional): The tag type's order relative to other tag types } tagTypeKey { tagTypeCode (string): The tag type reference code } `{ "tagTypeKey": { "tagTypeCode": "string" }, "displayName": "string", "tagTypeOrder": 0 }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <tagTypeCreateRequest> <tagTypeKey> <tagTypeCode>string</tagTypeCode> </tagTypeKey> <displayName>string</displayName> <tagTypeOrder>0</tagTypeOrder> </tagTypeCreateRequest>` Click to set as parameter value

Response (Status 200)

tagType {

tagTypeKey (tagTypeKey):

The tag type unique key

,

displayName (string, optional):

The tag type's name in plain text for human readability

,

tagTypeOrder (integer, optional):

The tag type's order relative to other tag types

}
tagTypeKey {

tagTypeCode (string):

The tag type reference code

}

{
  "tagTypeKey": {
    "tagTypeCode": "string"
  },
  "displayName": "string",
  "tagTypeOrder": 0
}

<?xml version="1.0" encoding="UTF-8"?>
<tagType>
     <tagTypeKey>
          <tagTypeCode>string</tagTypeCode>
     </tagTypeKey>
     <displayName>string</displayName>
     <tagTypeOrder>0</tagTypeOrder>
</tagType>

Response Content Type

delete /tagTypes/{tagTypeCode}

deleteTagType

get /tagTypes/{tagTypeCode}

getTagType

put /tagTypes/{tagTypeCode}

updateTagType

Implementation Notes

Updates an existing tag type.

Parameters

Parameter	Value	Description	Parameter Type	Data Type
tagTypeCode		the tag type code	path	string
tagTypeUpdateRequest: the information needed to update the tag type	Parameter content type: Model JSON Schema XML Example tagTypeUpdateRequest { displayName (string): The tag type's name in plain text for human readability , tagTypeOrder (integer, optional): The tag type's order relative to other tag types } `{ "displayName": "string", "tagTypeOrder": 0 }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <tagTypeUpdateRequest> <displayName>string</displayName> <tagTypeOrder>0</tagTypeOrder> </tagTypeUpdateRequest>` Click to set as parameter value

Response (Status 200)

tagType {

tagTypeKey (tagTypeKey):

The tag type unique key

,

displayName (string, optional):

The tag type's name in plain text for human readability

,

tagTypeOrder (integer, optional):

The tag type's order relative to other tag types

}
tagTypeKey {

tagTypeCode (string):

The tag type reference code

}

{
  "tagTypeKey": {
    "tagTypeCode": "string"
  },
  "displayName": "string",
  "tagTypeOrder": 0
}

<?xml version="1.0" encoding="UTF-8"?>
<tagType>
     <tagTypeKey>
          <tagTypeCode>string</tagTypeCode>
     </tagTypeKey>
     <displayName>string</displayName>
     <tagTypeOrder>0</tagTypeOrder>
</tagType>

Response Content Type

post /tagTypes/search

searchTagTypes

Implementation Notes

Retrieves all tag types existing in the system. For each tag type entity, the endpoint returns tag type key by default along with any other top-level elements as specified by the "fields" query string parameter. The list of tag types returned by the endpoint is sorted alphabetically by tag type's order value ascending.

Parameters

Parameter	Value	Description	Parameter Type	Data Type
tagTypeSearchRequest: the tag type search request. The request does not take any search keys or filters	Parameter content type: Model JSON Schema XML Example tagTypeSearchRequest { noData (string, optional): There is nothing that is currently being posted, but we will have something in the future } `{ "noData": "string" }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <tagTypeSearchRequest> <noData>string</noData> </tagTypeSearchRequest>` Click to set as parameter value
fields		the field options for the tag type search response. The valid field options are: displayName, tagTypeOrder	query	string

Response (Status 200)

tagTypeSearchResponse {

tagTypes (Array[tagType], optional):

An ordered list of tag types. The list is sorted alphabetically by tag type's order value ascending

}
tagType {

tagTypeKey (tagTypeKey):

The tag type unique key

,

displayName (string, optional):

The tag type's name in plain text for human readability

,

tagTypeOrder (integer, optional):

The tag type's order relative to other tag types

}
tagTypeKey {

tagTypeCode (string):

The tag type reference code

}

{
  "tagTypes": [
    "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<tagType>\n   <tagTypeKey>\n      <tagTypeCode>string</tagTypeCode>\n   </tagTypeKey>\n   <displayName>string</displayName>\n   <tagTypeOrder>0</tagTypeOrder>\n</tagType>\n"
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<tagTypeSearchResponse>
     <tagTypes>
          <tagType>
               <tagTypeKey>
                    <tagTypeCode>string</tagTypeCode>
               </tagTypeKey>
               <displayName>string</displayName>
               <tagTypeOrder>0</tagTypeOrder>
          </tagType>
     </tagTypes>
</tagTypeSearchResponse>

Response Content Type

Upload and Download

post /download/businessObjectDefinitionSampleDataFile/single/initiation

initiateDownloadSingleSampleFile

Implementation Notes

Download a single business object definition sample file

Parameter (body):
Parameter content type: Model JSON Schema XML Example downloadBusinessObjectDefinitionSampleDataFileSingleInitiationRequest { businessObjectDefinitionSampleDataFileKey (businessObjectDefinitionSampleDataFileKey) } businessObjectDefinitionSampleDataFileKey { namespace (string): The namespace of the business object definition , businessObjectDefinitionName (string): The business object definition name , directoryPath (string): The directory path of the sample data file. Note that directory path will contain a trailing "directory" separator, thus the caller needs to concatenate the directory path and the file name as is in order to construct a fully qualified path for the sample data file , fileName (string): The name of the sample data file } `{ "businessObjectDefinitionSampleDataFileKey": { "namespace": "string", "businessObjectDefinitionName": "string", "directoryPath": "string", "fileName": "string" } }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <downloadBusinessObjectDefinitionSampleDataFileSingleInitiationRequest> <businessObjectDefinitionSampleDataFileKey> <namespace>string</namespace> <businessObjectDefinitionName>string</businessObjectDefinitionName> <directoryPath>string</directoryPath> <fileName>string</fileName> </businessObjectDefinitionSampleDataFileKey> </downloadBusinessObjectDefinitionSampleDataFileSingleInitiationRequest>` Click to set as parameter value

Response (Status 200)

downloadBusinessObjectDefinitionSampleDataFileSingleInitiationResponse {

businessObjectDefinitionSampleDataFileKey (businessObjectDefinitionSampleDataFileKey),

awsS3BucketName (string),

awsAccessKey (string),

awsSecretKey (string),

awsSessionToken (string),

awsSessionExpirationTime (string),

preSignedUrl (string)

}
businessObjectDefinitionSampleDataFileKey {

namespace (string):

The namespace of the business object definition

,

businessObjectDefinitionName (string):

The business object definition name

,

directoryPath (string):

The directory path of the sample data file. Note that directory path will contain a trailing "directory" separator, thus the caller needs to concatenate the directory path and the file name as is in order to construct a fully qualified path for the sample data file

,

fileName (string):

The name of the sample data file

}

{
  "businessObjectDefinitionSampleDataFileKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string",
    "directoryPath": "string",
    "fileName": "string"
  },
  "awsS3BucketName": "string",
  "awsAccessKey": "string",
  "awsSecretKey": "string",
  "awsSessionToken": "string",
  "awsSessionExpirationTime": "2017-04-29T14:40:27.186Z",
  "preSignedUrl": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<downloadBusinessObjectDefinitionSampleDataFileSingleInitiationResponse>
     <businessObjectDefinitionSampleDataFileKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <directoryPath>string</directoryPath>
          <fileName>string</fileName>
     </businessObjectDefinitionSampleDataFileKey>
     <awsS3BucketName>string</awsS3BucketName>
     <awsAccessKey>string</awsAccessKey>
     <awsSecretKey>string</awsSecretKey>
     <awsSessionToken>string</awsSessionToken>
     <awsSessionExpirationTime>2015-12-25T00:00:00.000-05:00</awsSessionExpirationTime>
     <preSignedUrl>string</preSignedUrl>
</downloadBusinessObjectDefinitionSampleDataFileSingleInitiationResponse>

Response Content Type

get /download/single/initiation/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/businessObjectDataVersions/{businessObjectDataVersion}

initiateDownloadSingle

Implementation Notes

Initiates a download of a single file.

Requires READ permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace.	path	string
businessObjectDefinitionName	the business object definition name.	path	string
businessObjectFormatUsage	the business object format usage.	path	string
businessObjectFormatFileType	the business object format file type.	path	string
businessObjectFormatVersion	the business object format version.	path	integer
partitionValue	the partition value.	path	string
businessObjectDataVersion	the business object data version.	path	integer

Response (Status 200)

downloadSingleInitiationResponse {

businessObjectData (businessObjectData),

awsAccessKey (string),

awsSecretKey (string),

awsSessionToken (string),

awsSessionExpirationTime (string),

preSignedUrl (string)

}
businessObjectData {

id (integer, optional):

The internal Id that uniquely references the newly created Business Object Data

,

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionKey (string):

The Partition Key this Business Object Data is being registered with. This must be they Partition Key specified in the Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with this Business Object Data

,

version (integer, optional):

The numeric version of a Business Object Data. Each time a new data object is registered, the new version will be the previous version + 1

,

latestVersion (boolean, optional):

No longer in use A boolean flag that shows whether this instance of data is the latest or not. Once a new version of data is registered, any previous versions will no longer be the latest

,

status (string, optional):

The status of the Business Object Data. One of the following values: VALID, UPLOADING, PENDING_VALID, PROCESSING, INVALID, ARCHIVED, EXPIRED, or DELETED

,

storageUnits (Array[storageUnit], optional):

A container for the Storage Units associated with a Business Object Data

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage. Attributes values are required for certain keys that are defined as Attribute Definitions in the Business Object Format

,

businessObjectDataParents (Array[businessObjectDataKey], optional):

A list of Business Object Data parents (i.e. predecessors) that were used/needed in the creation of this data. This is used for data lineage. Each parent consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataChildren (Array[businessObjectDataKey], optional):

A list of Business Object Data children that were creation from this data. This is used for data lineage. Each child consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataStatusHistory (Array[businessObjectDataStatusChangeEvent], optional):

Lists all business object data status change events for this business object data

}
storageUnit {

storage (storage):

The Storage for this Storage Unit

,

storageDirectory (storageDirectory, optional):

A container for a Storage Directory that resides within a specific Storage Unit

,

storageFiles (Array[storageFile], optional):

A container of various Storage Files that reside within a specific Storage Unit

,

storageUnitStatus (string, optional):

The status of this Storage Unit. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}
businessObjectDataKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values this Business Object Data is associated with

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

}
businessObjectDataStatusChangeEvent {

status (string):

The status of the Business Object Data

,

eventTime (string):

The timestamp of when the business object data status change occurred

,

userId (string):

The User ID of the user who performed status update or registration of the Business Object Data

}
storage {

name (string):

Name of Storage

,

storagePlatformName (string):

Name of Storage Platform (eg S3) associated with this Storage

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage

}
storageDirectory {

directoryPath (string):

The fully qualified storage directory path

}
storageFile {

filePath (string):

The fully qualified file path to the data. When Storage Directory is specified, all Storage File paths should start with the Storage Directory path

,

fileSizeBytes (integer, optional):

The file size in bytes

,

rowCount (integer, optional):

The number of lines in the file

}

{
  "businessObjectData": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<businessObjectData>\n   <id>0</id>\n   <namespace>string</namespace>\n   <businessObjectDefinitionName>string</businessObjectDefinitionName>\n   <businessObjectFormatUsage>string</businessObjectFormatUsage>\n   <businessObjectFormatFileType>string</businessObjectFormatFileType>\n   <businessObjectFormatVersion>0</businessObjectFormatVersion>\n   <partitionKey>string</partitionKey>\n   <partitionValue>string</partitionValue>\n   <subPartitionValues>\n      <partitionValue>string</partitionValue>\n   </subPartitionValues>\n   <version>0</version>\n   <latestVersion>true</latestVersion>\n   <status>string</status>\n   <storageUnits>\n      <storageUnit>\n         <storage>\n            <name>string</name>\n            <storagePlatformName>string</storagePlatformName>\n            <attributes>\n               <attribute>\n                  <name>string</name>\n                  <value>string</value>\n               </attribute>\n            </attributes>\n         </storage>\n         <storageDirectory>\n            <directoryPath>string</directoryPath>\n         </storageDirectory>\n         <storageFiles>\n            <storageFile>\n               <filePath>string</filePath>\n               <fileSizeBytes>0</fileSizeBytes>\n               <rowCount>0</rowCount>\n            </storageFile>\n         </storageFiles>\n         <storageUnitStatus>string</storageUnitStatus>\n      </storageUnit>\n   </storageUnits>\n   <attributes>\n      <attribute>\n         <name>string</name>\n         <value>string</value>\n      </attribute>\n   </attributes>\n   <businessObjectDataParents>\n      <businessObjectDataKey>\n         <namespace>string</namespace>\n         <businessObjectDefinitionName>string</businessObjectDefinitionName>\n         <businessObjectFormatUsage>string</businessObjectFormatUsage>\n         <businessObjectFormatFileType>string</businessObjectFormatFileType>\n         <businessObjectFormatVersion>0</businessObjectFormatVersion>\n         <partitionValue>string</partitionValue>\n         <subPartitionValues>\n            <partitionValue>string</partitionValue>\n         </subPartitionValues>\n         <businessObjectDataVersion>0</businessObjectDataVersion>\n      </businessObjectDataKey>\n   </businessObjectDataParents>\n   <businessObjectDataChildren>\n      <businessObjectDataKey>\n         <namespace>string</namespace>\n         <businessObjectDefinitionName>string</businessObjectDefinitionName>\n         <businessObjectFormatUsage>string</businessObjectFormatUsage>\n         <businessObjectFormatFileType>string</businessObjectFormatFileType>\n         <businessObjectFormatVersion>0</businessObjectFormatVersion>\n         <partitionValue>string</partitionValue>\n         <subPartitionValues>\n            <partitionValue>string</partitionValue>\n         </subPartitionValues>\n         <businessObjectDataVersion>0</businessObjectDataVersion>\n      </businessObjectDataKey>\n   </businessObjectDataChildren>\n   <businessObjectDataStatusHistory>\n      <businessObjectDataStatusChangeEvent>\n         <status>string</status>\n         <eventTime>2015-12-25T00:00:00.000-05:00</eventTime>\n         <userId>string</userId>\n      </businessObjectDataStatusChangeEvent>\n   </businessObjectDataStatusHistory>\n</businessObjectData>\n",
  "awsAccessKey": "string",
  "awsSecretKey": "string",
  "awsSessionToken": "string",
  "awsSessionExpirationTime": "2017-04-29T14:40:27.188Z",
  "preSignedUrl": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<downloadSingleInitiationResponse>
     <businessObjectData>
          <id>0</id>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionKey>string</partitionKey>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <version>0</version>
          <latestVersion>true</latestVersion>
          <status>string</status>
          <storageUnits>
               <storageUnit>
                    <storage>
                         <name>string</name>
                         <storagePlatformName>string</storagePlatformName>
                         <attributes>
                              <attribute>
                                   <name>string</name>
                                   <value>string</value>
                              </attribute>
                         </attributes>
                    </storage>
                    <storageDirectory>
                         <directoryPath>string</directoryPath>
                    </storageDirectory>
                    <storageFiles>
                         <storageFile>
                              <filePath>string</filePath>
                              <fileSizeBytes>0</fileSizeBytes>
                              <rowCount>0</rowCount>
                         </storageFile>
                    </storageFiles>
                    <storageUnitStatus>string</storageUnitStatus>
               </storageUnit>
          </storageUnits>
          <attributes>
               <attribute>
                    <name>string</name>
                    <value>string</value>
               </attribute>
          </attributes>
          <businessObjectDataParents>
               <businessObjectDataKey>
                    <namespace>string</namespace>
                    <businessObjectDefinitionName>string</businessObjectDefinitionName>
                    <businessObjectFormatUsage>string</businessObjectFormatUsage>
                    <businessObjectFormatFileType>string</businessObjectFormatFileType>
                    <businessObjectFormatVersion>0</businessObjectFormatVersion>
                    <partitionValue>string</partitionValue>
                    <subPartitionValues>
                         <partitionValue>string</partitionValue>
                    </subPartitionValues>
                    <businessObjectDataVersion>0</businessObjectDataVersion>
               </businessObjectDataKey>
          </businessObjectDataParents>
          <businessObjectDataChildren>
               <businessObjectDataKey>
                    <namespace>string</namespace>
                    <businessObjectDefinitionName>string</businessObjectDefinitionName>
                    <businessObjectFormatUsage>string</businessObjectFormatUsage>
                    <businessObjectFormatFileType>string</businessObjectFormatFileType>
                    <businessObjectFormatVersion>0</businessObjectFormatVersion>
                    <partitionValue>string</partitionValue>
                    <subPartitionValues>
                         <partitionValue>string</partitionValue>
                    </subPartitionValues>
                    <businessObjectDataVersion>0</businessObjectDataVersion>
               </businessObjectDataKey>
          </businessObjectDataChildren>
          <businessObjectDataStatusHistory>
               <businessObjectDataStatusChangeEvent>
                    <status>string</status>
                    <eventTime>2015-12-25T00:00:00.000-05:00</eventTime>
                    <userId>string</userId>
               </businessObjectDataStatusChangeEvent>
          </businessObjectDataStatusHistory>
     </businessObjectData>
     <awsAccessKey>string</awsAccessKey>
     <awsSecretKey>string</awsSecretKey>
     <awsSessionToken>string</awsSessionToken>
     <awsSessionExpirationTime>2015-12-25T00:00:00.000-05:00</awsSessionExpirationTime>
     <preSignedUrl>string</preSignedUrl>
</downloadSingleInitiationResponse>

Response Content Type

post /upload/businessObjectDefinitionSampleDataFile/initiation

initiateUploadSampleFile

Implementation Notes

Provide the location and credentials prior to upload a Sample Data file

Parameter (body): request to upload
Parameter content type: Model JSON Schema XML Example uploadBusinessObjectDefinitionSampleDataFileInitiationRequest { businessObjectDefinitionKey (businessObjectDefinitionKey) } businessObjectDefinitionKey { namespace (string): The name of a valid Namespace known by the system , businessObjectDefinitionName (string): The name for this Business Object Definition } `{ "businessObjectDefinitionKey": { "namespace": "string", "businessObjectDefinitionName": "string" } }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <uploadBusinessObjectDefinitionSampleDataFileInitiationRequest> <businessObjectDefinitionKey> <namespace>string</namespace> <businessObjectDefinitionName>string</businessObjectDefinitionName> </businessObjectDefinitionKey> </uploadBusinessObjectDefinitionSampleDataFileInitiationRequest>` Click to set as parameter value

Response (Status 200)

uploadBusinessObjectDefinitionSampleDataFileInitiationResponse {

businessObjectDefinitionKey (businessObjectDefinitionKey),

awsS3BucketName (string),

s3Endpoint (string),

s3KeyPrefix (string),

awsAccessKey (string),

awsSecretKey (string),

awsSessionToken (string),

awsSessionExpirationTime (string)

}
businessObjectDefinitionKey {

namespace (string):

The name of a valid Namespace known by the system

,

businessObjectDefinitionName (string):

The name for this Business Object Definition

}

{
  "businessObjectDefinitionKey": {
    "namespace": "string",
    "businessObjectDefinitionName": "string"
  },
  "awsS3BucketName": "string",
  "s3Endpoint": "string",
  "s3KeyPrefix": "string",
  "awsAccessKey": "string",
  "awsSecretKey": "string",
  "awsSessionToken": "string",
  "awsSessionExpirationTime": "2017-04-29T14:40:27.194Z"
}

<?xml version="1.0" encoding="UTF-8"?>
<uploadBusinessObjectDefinitionSampleDataFileInitiationResponse>
     <businessObjectDefinitionKey>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
     </businessObjectDefinitionKey>
     <awsS3BucketName>string</awsS3BucketName>
     <s3Endpoint>string</s3Endpoint>
     <s3KeyPrefix>string</s3KeyPrefix>
     <awsAccessKey>string</awsAccessKey>
     <awsSecretKey>string</awsSecretKey>
     <awsSessionToken>string</awsSessionToken>
     <awsSessionExpirationTime>2015-12-25T00:00:00.000-05:00</awsSessionExpirationTime>
</uploadBusinessObjectDefinitionSampleDataFileInitiationResponse>

Response Content Type

get /upload/single/credential/extension/namespaces/{namespace}/businessObjectDefinitionNames/{businessObjectDefinitionName}/businessObjectFormatUsages/{businessObjectFormatUsage}/businessObjectFormatFileTypes/{businessObjectFormatFileType}/businessObjectFormatVersions/{businessObjectFormatVersion}/partitionValues/{partitionValue}/businessObjectDataVersions/{businessObjectDataVersion}

extendUploadSingleCredentials

Implementation Notes

Extends the credentials for a previously initiated upload.

Requires WRITE permission on namespace

Parameters

Parameter	Description	Parameter Type	Data Type
namespace	the namespace.	path	string
businessObjectDefinitionName	the business object definition name.	path	string
businessObjectFormatUsage	the business object format usage.	path	string
businessObjectFormatFileType	the business object format file type.	path	string
businessObjectFormatVersion	the business object format version.	path	integer
partitionValue	the partition value.	path	string
businessObjectDataVersion	the business object data version.	path	integer

Response (Status 200)

uploadSingleCredentialExtensionResponse {

awsAccessKey (string),

awsSecretKey (string),

awsSessionToken (string),

awsSessionExpirationTime (string)

}

{
  "awsAccessKey": "string",
  "awsSecretKey": "string",
  "awsSessionToken": "string",
  "awsSessionExpirationTime": "2017-04-29T14:40:27.196Z"
}

<?xml version="1.0" encoding="UTF-8"?>
<uploadSingleCredentialExtensionResponse>
     <awsAccessKey>string</awsAccessKey>
     <awsSecretKey>string</awsSecretKey>
     <awsSessionToken>string</awsSessionToken>
     <awsSessionExpirationTime>2015-12-25T00:00:00.000-05:00</awsSessionExpirationTime>
</uploadSingleCredentialExtensionResponse>

Response Content Type

post /upload/single/initiation

initiateUploadSingle

Implementation Notes

Initiates a single file upload capability by creating the relative business object data instance in UPLOADING state and allowing write access to a specific location in S3_MANAGED_LOADING_DOCK storage.

Requires WRITE permission on namespace

Parameter (body): the information needed to initiate a file upload
Parameter content type: Model JSON Schema XML Example uploadSingleInitiationRequest { sourceBusinessObjectFormatKey (businessObjectFormatKey): The source business object format key , targetBusinessObjectFormatKey (businessObjectFormatKey): The target business object format key , businessObjectDataAttributes (Array[attribute], optional): The business object data attributes , file (file): The file to upload , targetStorageName (string, optional): The target storage name to move the encrypted file to } businessObjectFormatKey { namespace (string): The Namespace to which a Business Object Format is related , businessObjectDefinitionName (string): The name of the Business Object Definition to which a Business Object Format is related , businessObjectFormatUsage (string): The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions , businessObjectFormatFileType (string): A File Type known to the system that describes the file type of data stored under a Business Object Format , businessObjectFormatVersion (integer, optional): The numeric version of a Business Object Format. Each time a format is registered, the new version will be the previous version `+ 1` } attribute { name (string): Attribute key , value (string, optional): Attribute value } file { fileName (string), fileSizeBytes (integer, optional) } { "sourceBusinessObjectFormatKey": { "namespace": "string", "businessObjectDefinitionName": "string", "businessObjectFormatUsage": "string", "businessObjectFormatFileType": "string", "businessObjectFormatVersion": 0 }, "targetBusinessObjectFormatKey": { "namespace": "string", "businessObjectDefinitionName": "string", "businessObjectFormatUsage": "string", "businessObjectFormatFileType": "string", "businessObjectFormatVersion": 0 }, "businessObjectDataAttributes": [ { "name": "string", "value": "string" } ], "file": { "fileName": "string", "fileSizeBytes": 0 }, "targetStorageName": "string" } Click to set as parameter value <?xml version="1.0" encoding="UTF-8"?> <uploadSingleInitiationRequest> <sourceBusinessObjectFormatKey> <namespace>string</namespace> <businessObjectDefinitionName>string</businessObjectDefinitionName> <businessObjectFormatUsage>string</businessObjectFormatUsage> <businessObjectFormatFileType>string</businessObjectFormatFileType> <businessObjectFormatVersion>0</businessObjectFormatVersion> </sourceBusinessObjectFormatKey> <targetBusinessObjectFormatKey> <namespace>string</namespace> <businessObjectDefinitionName>string</businessObjectDefinitionName> <businessObjectFormatUsage>string</businessObjectFormatUsage> <businessObjectFormatFileType>string</businessObjectFormatFileType> <businessObjectFormatVersion>0</businessObjectFormatVersion> </targetBusinessObjectFormatKey> <businessObjectDataAttributes> <attribute> <name>string</name> <value>string</value> </attribute> </businessObjectDataAttributes> <file> <fileName>string</fileName> <fileSizeBytes>0</fileSizeBytes> </file> <targetStorageName>string</targetStorageName> </uploadSingleInitiationRequest> Click to set as parameter value

Response (Status 200)

uploadSingleInitiationResponse {

sourceBusinessObjectData (businessObjectData):

The source business object format key

,

targetBusinessObjectData (businessObjectData):

The target business object format key

,

file (file):

The file to upload

,

uuid (string):

The UUID generated for this upload

,

awsAccessKey (string):

The AWS access key that must be used to upload to this object in S3

,

awsSecretKey (string):

The AWS secret key that must be used to upload to this object in S3

,

awsSessionToken (string):

The AWS session token that must be used to upload to this object in S3

,

awsSessionExpirationTime (string):

The timestamp of when the provided AWS credentials will expire

,

awsKmsKeyId (string):

The KMS key ID that must be used to do SSE

,

targetStorageName (string):

The target storage name

}
businessObjectData {

id (integer, optional):

The internal Id that uniquely references the newly created Business Object Data

,

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionKey (string):

The Partition Key this Business Object Data is being registered with. This must be they Partition Key specified in the Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values associated with this Business Object Data

,

version (integer, optional):

The numeric version of a Business Object Data. Each time a new data object is registered, the new version will be the previous version + 1

,

latestVersion (boolean, optional):

No longer in use A boolean flag that shows whether this instance of data is the latest or not. Once a new version of data is registered, any previous versions will no longer be the latest

,

status (string, optional):

The status of the Business Object Data. One of the following values: VALID, UPLOADING, PENDING_VALID, PROCESSING, INVALID, ARCHIVED, EXPIRED, or DELETED

,

storageUnits (Array[storageUnit], optional):

A container for the Storage Units associated with a Business Object Data

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage. Attributes values are required for certain keys that are defined as Attribute Definitions in the Business Object Format

,

businessObjectDataParents (Array[businessObjectDataKey], optional):

A list of Business Object Data parents (i.e. predecessors) that were used/needed in the creation of this data. This is used for data lineage. Each parent consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataChildren (Array[businessObjectDataKey], optional):

A list of Business Object Data children that were creation from this data. This is used for data lineage. Each child consists of the key data that uniquely defines a reference to a single Business Object Data.

,

businessObjectDataStatusHistory (Array[businessObjectDataStatusChangeEvent], optional):

Lists all business object data status change events for this business object data

}
file {

fileName (string),

fileSizeBytes (integer, optional)

}
storageUnit {

storage (storage):

The Storage for this Storage Unit

,

storageDirectory (storageDirectory, optional):

A container for a Storage Directory that resides within a specific Storage Unit

,

storageFiles (Array[storageFile], optional):

A container of various Storage Files that reside within a specific Storage Unit

,

storageUnitStatus (string, optional):

The status of this Storage Unit. One of the following values: ENABLED, DISABLED, ARCHIVING, or RESTORING

}
attribute {

name (string):

Attribute key

,

value (string, optional):

Attribute value

}
businessObjectDataKey {

namespace (string):

The Namespace to which a Business Object Format is related

,

businessObjectDefinitionName (string):

The name of the Business Object Definition to which a Business Object Format is related

,

businessObjectFormatUsage (string):

The Usage of this Business Object Format - a string describing how this format is used. Often used as a label for the Business Object Format. Does not have to be unique in the system, the Usage string is frequently shared across formats for multiple Business Object Definitions

,

businessObjectFormatFileType (string):

A File Type known to the system that describes the file type of data stored under a Business Object Format

,

businessObjectFormatVersion (integer, optional):

The Business Object Format Version for a previously registered Business Object Format

,

partitionValue (string):

The Partition Value that this Business Object Data is associated with

,

subPartitionValues (Array[string], optional):

A list of Sub-Partition values this Business Object Data is associated with

,

businessObjectDataVersion (integer, optional):

The numeric version of a Business Object Data

}
businessObjectDataStatusChangeEvent {

status (string):

The status of the Business Object Data

,

eventTime (string):

The timestamp of when the business object data status change occurred

,

userId (string):

The User ID of the user who performed status update or registration of the Business Object Data

}
storage {

name (string):

Name of Storage

,

storagePlatformName (string):

Name of Storage Platform (eg S3) associated with this Storage

,

attributes (Array[attribute], optional):

Collection of name-value pairs. This can be used to store things such as S3 bucket names, validation flags, and custom user-defined meta-data about this storage

}
storageDirectory {

directoryPath (string):

The fully qualified storage directory path

}
storageFile {

filePath (string):

The fully qualified file path to the data. When Storage Directory is specified, all Storage File paths should start with the Storage Directory path

,

fileSizeBytes (integer, optional):

The file size in bytes

,

rowCount (integer, optional):

The number of lines in the file

}

{
  "sourceBusinessObjectData": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<businessObjectData>\n   <id>0</id>\n   <namespace>string</namespace>\n   <businessObjectDefinitionName>string</businessObjectDefinitionName>\n   <businessObjectFormatUsage>string</businessObjectFormatUsage>\n   <businessObjectFormatFileType>string</businessObjectFormatFileType>\n   <businessObjectFormatVersion>0</businessObjectFormatVersion>\n   <partitionKey>string</partitionKey>\n   <partitionValue>string</partitionValue>\n   <subPartitionValues>\n      <partitionValue>string</partitionValue>\n   </subPartitionValues>\n   <version>0</version>\n   <latestVersion>true</latestVersion>\n   <status>string</status>\n   <storageUnits>\n      <storageUnit>\n         <storage>\n            <name>string</name>\n            <storagePlatformName>string</storagePlatformName>\n            <attributes>\n               <attribute>\n                  <name>string</name>\n                  <value>string</value>\n               </attribute>\n            </attributes>\n         </storage>\n         <storageDirectory>\n            <directoryPath>string</directoryPath>\n         </storageDirectory>\n         <storageFiles>\n            <storageFile>\n               <filePath>string</filePath>\n               <fileSizeBytes>0</fileSizeBytes>\n               <rowCount>0</rowCount>\n            </storageFile>\n         </storageFiles>\n         <storageUnitStatus>string</storageUnitStatus>\n      </storageUnit>\n   </storageUnits>\n   <attributes>\n      <attribute>\n         <name>string</name>\n         <value>string</value>\n      </attribute>\n   </attributes>\n   <businessObjectDataParents>\n      <businessObjectDataKey>\n         <namespace>string</namespace>\n         <businessObjectDefinitionName>string</businessObjectDefinitionName>\n         <businessObjectFormatUsage>string</businessObjectFormatUsage>\n         <businessObjectFormatFileType>string</businessObjectFormatFileType>\n         <businessObjectFormatVersion>0</businessObjectFormatVersion>\n         <partitionValue>string</partitionValue>\n         <subPartitionValues>\n            <partitionValue>string</partitionValue>\n         </subPartitionValues>\n         <businessObjectDataVersion>0</businessObjectDataVersion>\n      </businessObjectDataKey>\n   </businessObjectDataParents>\n   <businessObjectDataChildren>\n      <businessObjectDataKey>\n         <namespace>string</namespace>\n         <businessObjectDefinitionName>string</businessObjectDefinitionName>\n         <businessObjectFormatUsage>string</businessObjectFormatUsage>\n         <businessObjectFormatFileType>string</businessObjectFormatFileType>\n         <businessObjectFormatVersion>0</businessObjectFormatVersion>\n         <partitionValue>string</partitionValue>\n         <subPartitionValues>\n            <partitionValue>string</partitionValue>\n         </subPartitionValues>\n         <businessObjectDataVersion>0</businessObjectDataVersion>\n      </businessObjectDataKey>\n   </businessObjectDataChildren>\n   <businessObjectDataStatusHistory>\n      <businessObjectDataStatusChangeEvent>\n         <status>string</status>\n         <eventTime>2015-12-25T00:00:00.000-05:00</eventTime>\n         <userId>string</userId>\n      </businessObjectDataStatusChangeEvent>\n   </businessObjectDataStatusHistory>\n</businessObjectData>\n",
  "targetBusinessObjectData": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<businessObjectData>\n   <id>0</id>\n   <namespace>string</namespace>\n   <businessObjectDefinitionName>string</businessObjectDefinitionName>\n   <businessObjectFormatUsage>string</businessObjectFormatUsage>\n   <businessObjectFormatFileType>string</businessObjectFormatFileType>\n   <businessObjectFormatVersion>0</businessObjectFormatVersion>\n   <partitionKey>string</partitionKey>\n   <partitionValue>string</partitionValue>\n   <subPartitionValues>\n      <partitionValue>string</partitionValue>\n   </subPartitionValues>\n   <version>0</version>\n   <latestVersion>true</latestVersion>\n   <status>string</status>\n   <storageUnits>\n      <storageUnit>\n         <storage>\n            <name>string</name>\n            <storagePlatformName>string</storagePlatformName>\n            <attributes>\n               <attribute>\n                  <name>string</name>\n                  <value>string</value>\n               </attribute>\n            </attributes>\n         </storage>\n         <storageDirectory>\n            <directoryPath>string</directoryPath>\n         </storageDirectory>\n         <storageFiles>\n            <storageFile>\n               <filePath>string</filePath>\n               <fileSizeBytes>0</fileSizeBytes>\n               <rowCount>0</rowCount>\n            </storageFile>\n         </storageFiles>\n         <storageUnitStatus>string</storageUnitStatus>\n      </storageUnit>\n   </storageUnits>\n   <attributes>\n      <attribute>\n         <name>string</name>\n         <value>string</value>\n      </attribute>\n   </attributes>\n   <businessObjectDataParents>\n      <businessObjectDataKey>\n         <namespace>string</namespace>\n         <businessObjectDefinitionName>string</businessObjectDefinitionName>\n         <businessObjectFormatUsage>string</businessObjectFormatUsage>\n         <businessObjectFormatFileType>string</businessObjectFormatFileType>\n         <businessObjectFormatVersion>0</businessObjectFormatVersion>\n         <partitionValue>string</partitionValue>\n         <subPartitionValues>\n            <partitionValue>string</partitionValue>\n         </subPartitionValues>\n         <businessObjectDataVersion>0</businessObjectDataVersion>\n      </businessObjectDataKey>\n   </businessObjectDataParents>\n   <businessObjectDataChildren>\n      <businessObjectDataKey>\n         <namespace>string</namespace>\n         <businessObjectDefinitionName>string</businessObjectDefinitionName>\n         <businessObjectFormatUsage>string</businessObjectFormatUsage>\n         <businessObjectFormatFileType>string</businessObjectFormatFileType>\n         <businessObjectFormatVersion>0</businessObjectFormatVersion>\n         <partitionValue>string</partitionValue>\n         <subPartitionValues>\n            <partitionValue>string</partitionValue>\n         </subPartitionValues>\n         <businessObjectDataVersion>0</businessObjectDataVersion>\n      </businessObjectDataKey>\n   </businessObjectDataChildren>\n   <businessObjectDataStatusHistory>\n      <businessObjectDataStatusChangeEvent>\n         <status>string</status>\n         <eventTime>2015-12-25T00:00:00.000-05:00</eventTime>\n         <userId>string</userId>\n      </businessObjectDataStatusChangeEvent>\n   </businessObjectDataStatusHistory>\n</businessObjectData>\n",
  "file": {
    "fileName": "string",
    "fileSizeBytes": 0
  },
  "uuid": "string",
  "awsAccessKey": "string",
  "awsSecretKey": "string",
  "awsSessionToken": "string",
  "awsSessionExpirationTime": "2017-04-29T14:40:27.200Z",
  "awsKmsKeyId": "string",
  "targetStorageName": "string"
}

<?xml version="1.0" encoding="UTF-8"?>
<uploadSingleInitiationResponse>
     <sourceBusinessObjectData>
          <id>0</id>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionKey>string</partitionKey>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <version>0</version>
          <latestVersion>true</latestVersion>
          <status>string</status>
          <storageUnits>
               <storageUnit>
                    <storage>
                         <name>string</name>
                         <storagePlatformName>string</storagePlatformName>
                         <attributes>
                              <attribute>
                                   <name>string</name>
                                   <value>string</value>
                              </attribute>
                         </attributes>
                    </storage>
                    <storageDirectory>
                         <directoryPath>string</directoryPath>
                    </storageDirectory>
                    <storageFiles>
                         <storageFile>
                              <filePath>string</filePath>
                              <fileSizeBytes>0</fileSizeBytes>
                              <rowCount>0</rowCount>
                         </storageFile>
                    </storageFiles>
                    <storageUnitStatus>string</storageUnitStatus>
               </storageUnit>
          </storageUnits>
          <attributes>
               <attribute>
                    <name>string</name>
                    <value>string</value>
               </attribute>
          </attributes>
          <businessObjectDataParents>
               <businessObjectDataKey>
                    <namespace>string</namespace>
                    <businessObjectDefinitionName>string</businessObjectDefinitionName>
                    <businessObjectFormatUsage>string</businessObjectFormatUsage>
                    <businessObjectFormatFileType>string</businessObjectFormatFileType>
                    <businessObjectFormatVersion>0</businessObjectFormatVersion>
                    <partitionValue>string</partitionValue>
                    <subPartitionValues>
                         <partitionValue>string</partitionValue>
                    </subPartitionValues>
                    <businessObjectDataVersion>0</businessObjectDataVersion>
               </businessObjectDataKey>
          </businessObjectDataParents>
          <businessObjectDataChildren>
               <businessObjectDataKey>
                    <namespace>string</namespace>
                    <businessObjectDefinitionName>string</businessObjectDefinitionName>
                    <businessObjectFormatUsage>string</businessObjectFormatUsage>
                    <businessObjectFormatFileType>string</businessObjectFormatFileType>
                    <businessObjectFormatVersion>0</businessObjectFormatVersion>
                    <partitionValue>string</partitionValue>
                    <subPartitionValues>
                         <partitionValue>string</partitionValue>
                    </subPartitionValues>
                    <businessObjectDataVersion>0</businessObjectDataVersion>
               </businessObjectDataKey>
          </businessObjectDataChildren>
          <businessObjectDataStatusHistory>
               <businessObjectDataStatusChangeEvent>
                    <status>string</status>
                    <eventTime>2015-12-25T00:00:00.000-05:00</eventTime>
                    <userId>string</userId>
               </businessObjectDataStatusChangeEvent>
          </businessObjectDataStatusHistory>
     </sourceBusinessObjectData>
     <targetBusinessObjectData>
          <id>0</id>
          <namespace>string</namespace>
          <businessObjectDefinitionName>string</businessObjectDefinitionName>
          <businessObjectFormatUsage>string</businessObjectFormatUsage>
          <businessObjectFormatFileType>string</businessObjectFormatFileType>
          <businessObjectFormatVersion>0</businessObjectFormatVersion>
          <partitionKey>string</partitionKey>
          <partitionValue>string</partitionValue>
          <subPartitionValues>
               <partitionValue>string</partitionValue>
          </subPartitionValues>
          <version>0</version>
          <latestVersion>true</latestVersion>
          <status>string</status>
          <storageUnits>
               <storageUnit>
                    <storage>
                         <name>string</name>
                         <storagePlatformName>string</storagePlatformName>
                         <attributes>
                              <attribute>
                                   <name>string</name>
                                   <value>string</value>
                              </attribute>
                         </attributes>
                    </storage>
                    <storageDirectory>
                         <directoryPath>string</directoryPath>
                    </storageDirectory>
                    <storageFiles>
                         <storageFile>
                              <filePath>string</filePath>
                              <fileSizeBytes>0</fileSizeBytes>
                              <rowCount>0</rowCount>
                         </storageFile>
                    </storageFiles>
                    <storageUnitStatus>string</storageUnitStatus>
               </storageUnit>
          </storageUnits>
          <attributes>
               <attribute>
                    <name>string</name>
                    <value>string</value>
               </attribute>
          </attributes>
          <businessObjectDataParents>
               <businessObjectDataKey>
                    <namespace>string</namespace>
                    <businessObjectDefinitionName>string</businessObjectDefinitionName>
                    <businessObjectFormatUsage>string</businessObjectFormatUsage>
                    <businessObjectFormatFileType>string</businessObjectFormatFileType>
                    <businessObjectFormatVersion>0</businessObjectFormatVersion>
                    <partitionValue>string</partitionValue>
                    <subPartitionValues>
                         <partitionValue>string</partitionValue>
                    </subPartitionValues>
                    <businessObjectDataVersion>0</businessObjectDataVersion>
               </businessObjectDataKey>
          </businessObjectDataParents>
          <businessObjectDataChildren>
               <businessObjectDataKey>
                    <namespace>string</namespace>
                    <businessObjectDefinitionName>string</businessObjectDefinitionName>
                    <businessObjectFormatUsage>string</businessObjectFormatUsage>
                    <businessObjectFormatFileType>string</businessObjectFormatFileType>
                    <businessObjectFormatVersion>0</businessObjectFormatVersion>
                    <partitionValue>string</partitionValue>
                    <subPartitionValues>
                         <partitionValue>string</partitionValue>
                    </subPartitionValues>
                    <businessObjectDataVersion>0</businessObjectDataVersion>
               </businessObjectDataKey>
          </businessObjectDataChildren>
          <businessObjectDataStatusHistory>
               <businessObjectDataStatusChangeEvent>
                    <status>string</status>
                    <eventTime>2015-12-25T00:00:00.000-05:00</eventTime>
                    <userId>string</userId>
               </businessObjectDataStatusChangeEvent>
          </businessObjectDataStatusHistory>
     </targetBusinessObjectData>
     <file>
          <fileName>string</fileName>
          <fileSizeBytes>0</fileSizeBytes>
     </file>
     <uuid>string</uuid>
     <awsAccessKey>string</awsAccessKey>
     <awsSecretKey>string</awsSecretKey>
     <awsSessionToken>string</awsSessionToken>
     <awsSessionExpirationTime>2015-12-25T00:00:00.000-05:00</awsSessionExpirationTime>
     <awsKmsKeyId>string</awsKmsKeyId>
     <targetStorageName>string</targetStorageName>
</uploadSingleInitiationResponse>

Response Content Type

User Namespace Authorization

post /userNamespaceAuthorizations

createUserNamespaceAuthorization

Implementation Notes

Creates a new user namespace authorization.

The user ID field may be prefixed with a wildcard token character "" to authorize multiple users access to the namespace. The wildcard only works for as a prefix to match the suffix of the user ID. If the wildcard appears anywhere other than the prefix, the user ID must match as-is. For example:

john.doe@domain.com - only authorizes user with ID "john.doe@domain.com"

@domain.com - authorizes users that has the suffix "@domain.com"
- authorizes all users

john.doe - only authorizes user with ID "john.doe*"

Requires GRANT permission on namespace

Parameter (body): the information needed to create the user namespace authorization
Parameter content type: Model JSON Schema XML Example userNamespaceAuthorizationCreateRequest { userNamespaceAuthorizationKey (userNamespaceAuthorizationKey): The user namespace authorization key , namespacePermissions (Array[string], optional): The list of namespace permissions } userNamespaceAuthorizationKey { userId (string): The user id , namespace (string): The namespace } `{ "userNamespaceAuthorizationKey": { "userId": "string", "namespace": "string" }, "namespacePermissions": [ "READ" ] }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <userNamespaceAuthorizationCreateRequest> <userNamespaceAuthorizationKey> <userId>string</userId> <namespace>string</namespace> </userNamespaceAuthorizationKey> <namespacePermissions> <namespacePermission>READ</namespacePermission> </namespacePermissions> </userNamespaceAuthorizationCreateRequest>` Click to set as parameter value

Response (Status 200)

userNamespaceAuthorization {

id (integer, optional):

A system unique ID of this user namespace authorization

,

userNamespaceAuthorizationKey (userNamespaceAuthorizationKey):

The user namespace authorization key

,

namespacePermissions (Array[string], optional):

The list of namespace permissions

}
userNamespaceAuthorizationKey {

userId (string):

The user id

,

namespace (string):

The namespace

}

{
  "id": 0,
  "userNamespaceAuthorizationKey": {
    "userId": "string",
    "namespace": "string"
  },
  "namespacePermissions": [
    "READ"
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<userNamespaceAuthorization>
     <id>0</id>
     <userNamespaceAuthorizationKey>
          <userId>string</userId>
          <namespace>string</namespace>
     </userNamespaceAuthorizationKey>
     <namespacePermissions>
          <namespacePermission>READ</namespacePermission>
     </namespacePermissions>
</userNamespaceAuthorization>

Response Content Type

get /userNamespaceAuthorizations/namespaces/{namespace}

getUserNamespaceAuthorizationsByNamespace

Implementation Notes

Gets a list of user namespace authorizations for the specified namespace.

Parameters

Parameter	Value	Description	Parameter Type	Data Type
namespace		the namespace	path	string

Response (Status 200)

userNamespaceAuthorizations {

userNamespaceAuthorizations (Array[userNamespaceAuthorization], optional)

}
userNamespaceAuthorization {

id (integer, optional):

A system unique ID of this user namespace authorization

,

userNamespaceAuthorizationKey (userNamespaceAuthorizationKey):

The user namespace authorization key

,

namespacePermissions (Array[string], optional):

The list of namespace permissions

}
userNamespaceAuthorizationKey {

userId (string):

The user id

,

namespace (string):

The namespace

}

{
  "userNamespaceAuthorizations": [
    "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<userNamespaceAuthorization>\n   <id>0</id>\n   <userNamespaceAuthorizationKey>\n      <userId>string</userId>\n      <namespace>string</namespace>\n   </userNamespaceAuthorizationKey>\n   <namespacePermissions>\n      <namespacePermission>READ</namespacePermission>\n   </namespacePermissions>\n</userNamespaceAuthorization>\n"
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<userNamespaceAuthorizations>
     <userNamespaceAuthorization>
          <id>0</id>
          <userNamespaceAuthorizationKey>
               <userId>string</userId>
               <namespace>string</namespace>
          </userNamespaceAuthorizationKey>
          <namespacePermissions>
               <namespacePermission>READ</namespacePermission>
          </namespacePermissions>
     </userNamespaceAuthorization>
</userNamespaceAuthorizations>

Response Content Type

get /userNamespaceAuthorizations/userIds/{userId}

getUserNamespaceAuthorizationsByUserId

Implementation Notes

Gets a list of user namespace authorizations for the specified user.

Parameters

Parameter	Value	Description	Parameter Type	Data Type
userId		the user id	path	string

Response (Status 200)

userNamespaceAuthorizations {

userNamespaceAuthorizations (Array[userNamespaceAuthorization], optional)

}
userNamespaceAuthorization {

id (integer, optional):

A system unique ID of this user namespace authorization

,

userNamespaceAuthorizationKey (userNamespaceAuthorizationKey):

The user namespace authorization key

,

namespacePermissions (Array[string], optional):

The list of namespace permissions

}
userNamespaceAuthorizationKey {

userId (string):

The user id

,

namespace (string):

The namespace

}

{
  "userNamespaceAuthorizations": [
    "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<userNamespaceAuthorization>\n   <id>0</id>\n   <userNamespaceAuthorizationKey>\n      <userId>string</userId>\n      <namespace>string</namespace>\n   </userNamespaceAuthorizationKey>\n   <namespacePermissions>\n      <namespacePermission>READ</namespacePermission>\n   </namespacePermissions>\n</userNamespaceAuthorization>\n"
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<userNamespaceAuthorizations>
     <userNamespaceAuthorization>
          <id>0</id>
          <userNamespaceAuthorizationKey>
               <userId>string</userId>
               <namespace>string</namespace>
          </userNamespaceAuthorizationKey>
          <namespacePermissions>
               <namespacePermission>READ</namespacePermission>
          </namespacePermissions>
     </userNamespaceAuthorization>
</userNamespaceAuthorizations>

Response Content Type

delete /userNamespaceAuthorizations/userIds/{userId}/namespaces/{namespace}

deleteUserNamespaceAuthorization

get /userNamespaceAuthorizations/userIds/{userId}/namespaces/{namespace}

getUserNamespaceAuthorization

put /userNamespaceAuthorizations/userIds/{userId}/namespaces/{namespace}

updateUserNamespaceAuthorization

Implementation Notes

Updates an existing user namespace authorization by key.

Requires GRANT permission on namespace

Parameters

Parameter	Value	Description	Parameter Type	Data Type
userId		the user id	path	string
namespace		the namespace	path	string
userNamespaceAuthorizationUpdateRequest: the information needed to update the user namespace authorization	Parameter content type: Model JSON Schema XML Example userNamespaceAuthorizationUpdateRequest { namespacePermissions (Array[string], optional): The list of namespace permissions } `{ "namespacePermissions": [ "READ" ] }` Click to set as parameter value `<?xml version="1.0" encoding="UTF-8"?> <userNamespaceAuthorizationUpdateRequest> <namespacePermissions> <namespacePermission>READ</namespacePermission> </namespacePermissions> </userNamespaceAuthorizationUpdateRequest>` Click to set as parameter value

Response (Status 200)

userNamespaceAuthorization {

id (integer, optional):

A system unique ID of this user namespace authorization

,

userNamespaceAuthorizationKey (userNamespaceAuthorizationKey):

The user namespace authorization key

,

namespacePermissions (Array[string], optional):

The list of namespace permissions

}
userNamespaceAuthorizationKey {

userId (string):

The user id

,

namespace (string):

The namespace

}

{
  "id": 0,
  "userNamespaceAuthorizationKey": {
    "userId": "string",
    "namespace": "string"
  },
  "namespacePermissions": [
    "READ"
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<userNamespaceAuthorization>
     <id>0</id>
     <userNamespaceAuthorizationKey>
          <userId>string</userId>
          <namespace>string</namespace>
     </userNamespaceAuthorizationKey>
     <namespacePermissions>
          <namespacePermission>READ</namespacePermission>
     </namespacePermissions>
</userNamespaceAuthorization>

Response Content Type

Implementation Notes

Response (Status 200)

Curl

Request URL

Response Body

Response Code

Implementation Notes

Parameter (body): the information needed to create the business object data

Response (Status 200)

Curl

Request URL

Response Body

Response Code

Implementation Notes

Parameter (body): the business object data availability request

Response (Status 200)

Curl

Request URL

Response Body

Response Code

Implementation Notes

Parameter (body): the business object data availability collection request

Response (Status 200)

Curl

Request URL

Response Body

Response Code

Implementation Notes

Parameter (body): the business object data DDL request

Response (Status 200)

Curl

Request URL

Response Body

Response Code

Implementation Notes

Parameter (body): the business object data DDL collection request

Response (Status 200)

Curl

Request URL

Response Body

Response Code

Implementation Notes

Parameters

Response (Status 200)

Curl

Request URL

Response Body

Response Code

Implementation Notes

Parameters

Response (Status 200)

Curl

Request URL

Response Body

Response Code

Implementation Notes

Parameters

Response (Status 200)

Curl

Request URL

Response Body

Response Code

Implementation Notes

Parameters

Response (Status 200)

Curl

Request URL

Response Body

Response Code

Implementation Notes

Parameters

Response (Status 200)

Curl

Request URL

Response Body

Response Code

Implementation Notes

Parameters

Response (Status 200)

Curl